Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/alyyousuf7/todoapp-bootstrap

A sample application with ExpressJS + TypeORM
https://github.com/alyyousuf7/todoapp-bootstrap

Last synced: about 5 hours ago
JSON representation

A sample application with ExpressJS + TypeORM

Awesome Lists containing this project

README

        

# TodoApp
A simple app to maintain group of todo list.

Made a simple REST API server as a sample project with the following technologies:

- TypeScript (NodeJS v12)
- ExpressJS
- TypeORM
- Swagger
- Postgres
- Docker

# Setup

## Docker
- Clone the repository
- Run `docker-compose up`

## Without Docker
- Clone the repository
- Run `yarn install`
- Run `yarn typeorm migration:run`*
- Run `yarn watch`*

\* You need to set environment variables to provide configuration for database connection. Please see `src/config.ts` for environment variable names.

---

After the server is setup, you will be provided with an API Key on the terminal.

The API will be useable from the documentation available at http://localhost:3000/docs.