https://github.com/olaoluwam/todo-app-api

A todo app API written in fp-ts
https://github.com/olaoluwam/todo-app-api

fp-ts functional-programming nodejs

Last synced: 29 days ago
JSON representation

A todo app API written in fp-ts

• Host: GitHub
• URL: https://github.com/olaoluwam/todo-app-api
• Owner: OlaoluwaM
• Created: 2022-08-16T14:12:37.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-08-24T03:52:43.000Z (over 2 years ago)
• Last Synced: 2024-10-25T00:06:34.750Z (3 months ago)
• Topics: fp-ts, functional-programming, nodejs
• Language: TypeScript
• Homepage:
• Size: 1.02 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Todo app API

## Getting Started

This API is containerized so you should be up and running should you run

```bash

npm run compose:up

```

**But before you do**, you'll need to set your environment variables. Create a .env file

with the following non-sensitive values

```text

POSTGRES_USER=postgres

POSTGRES_PASSWORD=postgres123

POSTGRES_DB=todos

POSTGRES_PORT=5432

PORT=5003

SERVER_HOST=0.0.0.0

```

However, you can run the server nude if you have NodeJS installed on your machine. If you

prefer this route, you first need to run

```bash

npm i

```

then run either

```bash

npm run dev

# or

npm start

```

To access the documentation for this API, navigate to to the **/api/documentation** route!