padmajabhol / journal-policy-tracker-backend

Backend Repository for Journal Policy Tracker

Journal Policy Tracker: Backend

This is the backend repository for the Journal Policy Tracker web application.

Contribute to this project

Prerequisites:

• MongoDB 5.0 or newer.
• Yarn - Yarn is the package manager for this project.
• Redis - Redis is available only for Linux and Mac. If you are using Windows, you don't need to worry, a Native port of Redis for Windows is available here. This is more than sufficient to run this project on any Windows machine.

After installing the required applications, clone the repository and run the following commands.

Installing dependencies

yarn

Run Apollo Server

yarn dev

To run all the tests for the server:

yarn test

---

If you have any questions regarding setting up or the development of the project, see if you can find any answers in the FAQs section. If not then you can simply open an issue and ask. I'll try to get back to you ASAP.

Our Slack Community: Slack Invite

---

Contributions are welcome 🎉🎉

Please refer to the project's style and contribution guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.

1. Fork this repository on GitHub.
2. Clone the forked repository to your own machine.
3. Create a new branch. You can name the branch something related to the feature you are adding or the bug that you are fixing.
4. Commit changes to that branch.
5. Follow conventional commits to write the commit messages. Take a look at the past commit messages if needed.
6. Push the commits you made to your fork.
7. Submit a Pull request so that we can review your changes.
8. After the Pull Request is merged, you can delete that branch form your local fork.

Starware

This project is Starware.
This means you're free to use the project, as long as you star its GitHub repository.
Your appreciation makes us grow and glow up. ⭐