Canonizer-3.0

View Demo · Report Bug · Request New Feature

Table of Contents

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

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 standardise definitions and vocabulary, especially important in new fields.

(back to top)

Built With

• Next.js
• Redux Toolkit
• Ant Design
• Typescript
• Unit Testing
  • Jest
  • React Testing Library

(back to top)

Getting Started

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

Prerequisites

1. Git
2. Node: any 12.x version starting with v12.0.0 or greater
3. Yarn v1: See Yarn website for installation instructions
4. A fork of the repo (for any contributions)
5. A clone of the canonizer-3.0-frontend repo on your local machine

Installation

1. Clone the repo

   git clone https://github.com/the-canonizer/canonizer-3.0-frontend.git

2. Go into the project root

   cd canonizer-3.0-frontend

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

   cp .env.example .env

4. Install Dependency packages

   yarn

5. To start the hot-reloading development server

   yarn dev

6. To open the site in your favorite browser

   open http://localhost:4000

(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!

Create a branch

1. git checkout development from any folder in your local canonizer-3.0-frontend repository
2. git pull origin development 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 in the browser
2. Changes to React components in src will hot-reload

Test the change

1. If possible, test any visual changes in all latest versions of common browsers, on both desktop and mobile.
2. Run yarn test from the project root to ensure that no one test case is being failed.
3. Run yarn format from the project root. (This will run Prettier)
4. Run yarn build from the project root to ensure that build is created successfully.

Push the change

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

(back to top)

License

Lesser MIT License

Copyright (c) 2006-2023 Canonizer.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software with minimal restriction, including without limitation the rights to use, copy, modify, merge, publish, and distribute copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

Any activity arising from use under this license must maintain compliance with all related and dependent licensees.

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

(back to top)

Contact

Brent Allsop - @Brent's_twitter - brent.allsop@gmail.com

Project Link: https://canonizer3.canonizer.com

(back to top)