anapi

The API to publish and manage animals and their adoptions. Our focus is to help Amantes da Natureza group.

Getting started • Technologies • Credits

Getting started

To clone and run this application, you'll need Git and Node.js (which comes with npm) installed on your computer. If you feel like, you can install yarn globally to use alongside or instead of npm. From your command line:

# Clone this repository
$ git clone https://github.com/anatureza/anapi.git

# Go into the repository
$ cd anapi

# Install dependencies
$ yarn

Run the app

In order to run the app, you need to create a .env file in the root folder, then you should follow the .env.example.

# Run migrations
$ yarn typeorm migration:run

# Run the app
$ yarn dev

Now the app will be running on http://localhost:3333

Technologies

This project is being developed with the following technologies:

• Node.js
• Typescript
• Express
• TypeORM
• Insomnia
• JSONWebToken
• Handlebars
• Multer
• Date-fns

License

This project is under the MIT license