Canonizer-3.0

View Demo · Report Bug · Request New Feature

Table of Contents

1. Objective
2. About The Project
   • Built With
3. Getting Started
   • Prerequisites
   • Installation
4. Contributing
   • Fork this repository
   • Create a branch
   • Make the change
   • Push the change
5. License
6. Contact

Objective

The objective of this repo is to provide the core building block for (https://canonizer.com/). This repo is responsible for managing initial data for canonizer by linkup with Canonizer3.0(https://github.com/the-canonizer/canonizer-3.0-api) and responsible to store data mongodb.

About The Project

A wiki system that solves the critical liabilities of Wikipedia. It solves petty "edit wars" by providing contributors the ability to create and join camps and present their views without having them immediately erased. It also provides ways to standardize definitions and vocabulary, especially important in new fields.

(back to top)

Built With

• Laravel Lumen
• MongoDb
• Unit Testing
  • PHP Unit Testing

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

1. Git
2. PHP: version 7.4 or higher
3. MongoDb: version 6.0 or higher
4. MySql
5. Composer(https://getcomposer.org/download/)
6. A clone of the canonizer-service repo on your local machine

Installation

1. Clone the repo

   git clone https://github.com/the-canonizer/canonizer-service.git

2. Go into the project root

   cd canonizer-service

3. Copy environment variables from .env.example to .env file

   cp .env.example .env

4. Install Dependency packages

   composer install

5. Make the mongodb connection string and place in .env
6. To start the hot-reloading development server

   php artisan serve

7. Run the command to make data on mongodb.

   php artisan tree:all

8. Check the status of results on postman

   open http://localhost:8002 

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please clone the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

Fork this repository

Fork this repository by clicking on the fork button on the top of this page. This will create a copy of this repository in your account.

Branch Naming Conventions

To contribute on it for any issue you can check the rules/example for naming the branches. (https://docs.google.com/document/d/1qm5hqWfayHczDWOe74t-cLG7ovEJVa_jLhjICkaIjv8/)

Create a branch

1. git checkout master from any folder in your local canonizer-service repository
2. git pull origin master to ensure you have the latest main code
3. git checkout -b the-name-of-my-branch (replacing the-name-of-my-branch with a suitable name) to create a branch

Make the change

1. Save the files and check by requesting on any internal API.

Push the change

1. git add -A && git commit -m "My message" (replacing My message with a commit message, such as Fix in logic of specific function) to stage and commit your changes
2. git push my-fork-name the-name-of-my-branch
3. Go to the canonizer-service repo repo and you should see recently pushed branches.
4. Follow GitHub's instructions to create the Pull Request to master.
5. If possible, include screenshots of visual changes.

(back to top)

License

Will be added.

(back to top)

Contact

Brent Allsop - @Brent's_twitter - [email protected]

Project Link: https://canonizer.com

(back to top)