Skip to content

🗃 An API for file management built in Node.js.

Notifications You must be signed in to change notification settings

adrianoneres/files-api-nodejs

Repository files navigation

Files API

1. Development environment

2. Setup

2.1. Add your local configuration

Set up your local environment configurations in the file .env. If you don't have a .env file in the root directory, please copy the .env.example, rename it to .env and fill the properties values with your environment details.

2.2. Make sure you have the proper Node.js version installed:

nvm use && nvm install

2.3. Install dependencies

yarn

2.4. Create database structure

To create the files table in the database, run:

yarn typeorm migration:run

3. Development

To start the development server:

yarn dev

To run tests use:

yarn test

The API endpoints are available for testing at /api-docs.

5. Build

To build project to dist directory:

yarn build