Thank you for your interest in contributing to NotesReview!
If you want to work on improving the application, the following tips and hints may be useful for you. 😉
NotesReview is a web application and is therefore mainly written in Javascript. npm is used as the preferred package manager, Vite ⚡ is used as a module bundler.
You may want to take a look at the package.json file in order to get an overview on which modules are being used and what commands to run.
Before running the application, make sure the file app/.env with the following required environment variables exists:
NOTESREVIEW_API_URL=https://notesreview.kongruent.xyz/api
OPENSTREETMAP_SERVER=https://www.openstreetmap.orgThere are a few more environment variables that are used for additional features, but they are not mandatory to run the application, so in most cases the configuration above should be sufficient.
To setup, change and run the application locally, simply follow these steps:
# 1. Install all necessary dependencies using npm
npm install
# 2. Start the application by running the following command
# and visiting http://localhost:5173 in your browser
npm run dev
# 3. Now it's your turn — change, fix or improve something!That's it already! Now you can submit your change as a pull request on Github.
If you want to run the application in a docker container, you can use the following commands instead:
docker build --pull -t notesreview .
docker run -t -i -p 3000:5173 notesreviewIf you want to translate the website into your language or fix a wrong term, you can do so by visiting the project at POEditor.
Follow this link to improve the translations:
The use of POEditor is preferred over proposing new translations via pull requests.
The easiest way to contribute is of course to use and test the application and report bugs on Github using the issue tracker. Just let me know if you spot something that looks suspicious. 🙃