Allows Developers to better look for, and select their first open source contribution. You can also use this tool to just look for random repositories or issues that might fancy you.
Visit the tool here.
These instructions will give you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on deploying the project on a live system.
Requirements for the software and other tools to build, test and push.
- Node - I use Node v16.6.2 but really anything 12+ should work.
Clone this repository to your machine and run
npm installTo start up the dev server, run this:
npm run devWe have no tests :(
We'd like to add test cases. Check out the issues to learn more.
Check if the best practices and the right coding style has been used.
Run an npm run lint to see if there's any styling errors.
Also run npm run lint:fix to fix issues that can be auto-fixed.
Note that the build process will fail if there are lint issues.
NextJS works a bit differently to other JS dev-build cycles. To prepare for deployment, run this command:
npm run buildThis compiles and bundles the code into the .next folder. After this is done, run this command to start the production server.
npm run start- Contributor Covenant - Used for the Code of Conduct
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
We use Semantic Versioning for versioning. For the versions available, see the tags on this repository.
See also the list of contributors who participated in this project.
This project is licensed under the CC0 2.1 Universal Creative Commons License - see the LICENSE file for details
- Daren Sin - Created Good First Issues, the inspriation for this project - darensin01
- Billie Thompson - Provided README Template - PurpleBooth
- Tom Boettger - Provided CONTRIBUTING Template - bttger