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

https://github.com/olawale-o/nodejs-login-tracker

A Node.js REST API for tracking the login activities of users.
https://github.com/olawale-o/nodejs-login-tracker

docker docker-compose mysql nodejs postgresql

Last synced: 3 months ago
JSON representation

A Node.js REST API for tracking the login activities of users.

Awesome Lists containing this project

README

          

# LOGIN TRACKER

# Built with
- NodeJS
- PostgreSQL
- ExpressJS

# Getting started
## To get a local copy of this repository kindly follow the steps below.
- Scroll to top of this current repository
- Click on the `Code` button with background color green on the right end corner
- Click on the clipboard icon on the extreme right of the dropdown to copy the repository link
- In your local PC, open your terminal or command prompt in the folder you would like to clone this repository into
- Type `git clone (copied link)` on the currently opened terminal or command prompt
- Remember to change `(copied link)` to `git@github.com:olawale-o/nodejs-login-tracker.git` which is the name of the repository

# Running the app
## Development
### Install
```bash
npm install
```
### Cretae development database
```bash
npm create:db:dev
```
### Migrate development database
```bash
npm migrate:db:dev
```

### Usage
```bash
npm run dev
```

## Production
### Start container
```bash
docker compose up --build
```
### Stop container
```bash
docker compose down
```

### Stop container and remove volume

```bash
docker compose down --volumes
```

## Testing
### Create test database
```bash
db:create:test
```

### Run test

```bash
npm test
```

# Contributing
Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page.](https://github.com/olawale-o/nodejs-login-tracker/issues)
## Show your support

Give a ⭐️ if you like this project!