Thanks for taking the time to contribute to this project!
There are multiple tasks you can do in order to help us, for example:
- fill an issue to report bugs or your specific needs
- contribute to existing issues
- write a PR to improve the project
In order to make a code contribution, create a fork of WebCrate by clicking the "Fork" button on GitHub and cloning the repo to your local machine.
Please use the develop branch as a base for your contribution and make your changes on a new branch.
Ensure that you open a discussion to discuss the changes before submitting a PR.
Once you're finished, push your branch to your repo and create a pull request!
The WebCrate app constists of a Nuxt frontend with a Express backend. It uses Deta Base as its database and thus requires that you sign up for a Deta account to use it during development.
Once you are signed up, follow the steps below to get a local version of WebCrate up and running:
- Clone this repo
git clone https://github.com/WebCrateApp/webcrate && cd webcrate- Install the dependencies
npm install- Create .env file with your Deta Project Key
echo "DETA_PROJECT_KEY=your key" > .env- Run the app locally with hot reloading enabled
npm run devESlint is used for linting. It's recommended to add the corresponding extension to your editor. It's also possible to run the lint script with the following command:
npm run lintVerify that there are no lint errors before opening a PR.
Make sure your changes don't break anything. There are currently no integration/unit tests available.
That's it, happy coding!