Skip to content

Latest commit

 

History

History
37 lines (29 loc) · 2.02 KB

CONTRIBUTING.md

File metadata and controls

37 lines (29 loc) · 2.02 KB

Contributing to Learn Anything

There are many ways you can contribute. You can:

  • Improve the website by using it and adding resources you liked to relevant topics.
  • Improve our curated lists on various topics. Instructions for how to improve them can be found on each of the lists.
  • Submit issues with feature requests or bug reports. Please give as many details as possible. If you can (and want to) fix the issue, please tell us in the issue.
  • Contribute to the website via Pull Requests. Instructions below will provide all necessary information on how you can do that from setting up the website to run locally to how you can add and contribute changes to the code base.
  • Ask questions on Telegram and discuss ideas and share thoughts about the project.

Run the project

  1. Fork the project, clone your fork:
# Clone your fork
git clone https://github.com/<your-username>/learn-anything.git

# Navigate to the newly cloned directory
cd learn-anything
  1. Switch to neo4j branch with git checkout neo4j.
  2. Inside api dir. Run npm install to install dependencies. After it is done, run npm start to start Elasticsearch & neo4j.
  3. In another terminal. Inside app dir. Run npm install. Then run npm start to start the app.
  4. Connect to localhost:3000.

Submitting a Pull Request

Please go through existing issues and pull requests to check if somebody else is already working on the issue.

Thank you for taking the time to contribute! 💜