Technologies | Project | How to test | How to contribute | License
This project was developed with the following technologies:
💻 Node.js
🧰 Typescript
✅ Jest
📦 MongoDB
🛠Github Actions
🔌 Heroku
This API was developed to obtain the forecast of the beaches where you want to surf. Being able to give your rating for each visited beach.
- Clone the repository:
git clone https://github.com/willian2s/vuttr.git
- Install dependencies:
yarn install
- Add the environment variables in:
.env
- To run the tests:
yarn test
- Generate the build:
yarn build
- Start server:
yarn start
; or - Start development server:
yarn start:dev
Follow the instructions in Contributing
This project is under the MIT license. See the LICENSE file for more details.