This is API application for Poll component. It is based MVC framework.
This application is based on node.js. So you need to install node.js first. the user version is LTS v16.18.0
This application is based on MongoDB. and will be using mongoose as ORM.
- Clone the repository
- Install the dependencies
- Run the application
git clone [email protected]:myusuf963/poll-api.git
Or use https if you don't have ssh key:
git clone https://github.com/myusuf963/poll-api.git
npm install
npm run dev
will be using Postman for API documentation and testing. You can download postman from here https://www.postman.com/downloads/
We will be using git flow branching model. create a branch for each feature or fix.
- You can read more about it here https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow
We will be using conventional commit message.
- You can read more about it here https://www.conventionalcommits.org/en/v1.0.0/
We will be using pull request for code review. assign a reviewer for each pull request. don't merge your PR without other dev approval.
- You can read more about it here https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests
We will be using eslint for code style and prettier for formatting.please install eslint and prettier extension in your IDE. You can read more about it here https://eslint.org/docs/user-guide/getting-started