/forecast-api

Api of the surf meteorology application using StormGlass service

Primary LanguageTypeScriptMIT LicenseMIT

🌊🌊 FORECAST API 🌊🌊

PRs welcome! License Issues Forks Stars

Technologies   |    Project   |    How to test   |    How to contribute   |    License


Technologies

This project was developed with the following technologies:

💻 Node.js

🧰 Typescript

✅ Jest

📦 MongoDB

🛠 Github Actions

🔌 Heroku

Project

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.

📓 Access a documentation:

How to test

  • 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

How to contribute

Follow the instructions in Contributing

License

This project is under the MIT license. See the LICENSE file for more details.


Made with ♥ by Willian Silva