Happy API

happy-api is a REST API implementation built with Node.js + Express.js with TypeScript. This project was built during the event Next Level Week 3 by Rocketseat.

Packages & Libs

• Express
• dotenv
• Multer
• Cors
• sqlite3
• TypeORM
• Yup

Clone happy-api

Clone repo, in the project directory, you can run:

git clone [email protected]:cesardoliveira/happy-api.git
cd happy-api

Install Dependencies

npm

npm install

Yarn

yarn install

This command installs a package, and any packages that it depends on.

Getting Started

Before you start in Dev or Test enviroment make sure you have installed:

• Node.js

Also, check the file .env.example with all environment variables in the project and examples of how to fill up your .env file.

# .env

SERVER_PORT

Development

npm dev or yarn dev

Runs the API in the development mode.
Open http://localhost:3001 to view it in the browser.

You will also see any lint errors in the console.