About • Features • Tech Stack • License
This API delivers previsions of surf, like others sites such as Magicseaweed, where we can look for information about specific surf beaches, or point to you which beach is great to surf in a specific time and region
This project was intended to be a way to improve my skills in creating APIs, among other things like:
- TS
- TDD
- Clean architecture
- Jest Mocks
- External services integration
- JWT Auth flow
- MongoDB + Mongoose
- Github Workflows
- Rate Limit
- Open API documentation
- External API client to consume meteorological information
Before you begin, you will need to have the following tools installed on your machine: Git, Node.js, In addition, it is good to have an editor to work with the code like VSCode
# Clone this repository
$ git clone git@github.com:zEduardofaria/surf-beach-api.git
# Access the project folder cmd/terminal
$ cd surf-beach-api
# install the dependencies
$ yarn install
# Create a .env file based in .env-example
# Create a .env.test file based in .env-test-example
# Run the application in development mode
$ yarn start:dev
# The server will start at port: 3333 - go to http://localhost:3333
# Run unit tests
$ yarn test:unit
The following tools were used in the construction of the project:
Server (NodeJS + TypeScript)
See the file package.json
- Editor: Visual Studio Code
- API Test: Insomnia
This project is under the license MIT.
Made with love by Eduardo Faria 👋🏽 Get in Touch!