This is a Next.js project bootstrapped with create-next-app.
- Make sure you install the dependencies when you clone the project for the first time. Use whichever command below corresponding to your favourite package:
npm install
# or
yarn install
# or
pnpm install
# or
bun install-
Create a
.envfile in the root directory (same location as thepackage.jsonfile) to include the environment variables needed for the server to work properly (see.env.example). -
Run the development:
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun devOpen http://localhost:3000 with your browser to see the result.
See Jira for list of existing issues and to create branches for them.
Whenever you are done coding, make sure to always fix linting errors before doing a pull request. You can either use an eslint extension for your IDE or run npm run lint:fix to fix linting errors. If you only wish to check whether your code has any linting errors, run npm run lint instead.
We will be loosely following conventional commits guideline for our commit messages. See the table below for the list of commit types.
| Type | Description |
|---|---|
| feat | Commits that add a new feature |
| fix | Bug fixes |
| test | Addings or changing tests, basically any change within the test directory |
| refactor | Changes to source code that neither add a feature nor fixes a bug |
| build | Changes to CI or build configuration files (Docker, github actions) |
| chore | Anything else that doesn't modify any app or test files (linters, tsconfig, etc.) |
| revert | Reverts a previous commit |
We welcome contributions to the CareConnect Backend project. To contribute, please follow these steps:
- Create a new branch (
git checkout -b feature-branch). - Make your changes.
- Commit your changes (
git commit -m 'Add some feature'). - Push to the branch (
git push origin feature-branch). - Open a pull request.
To learn more about Next.js, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
You can check out the Next.js GitHub repository - your feedback and contributions are welcome!