https://github.com/anewage/tweetycs-api

https://github.com/anewage/tweetycs-api

Last synced: 18 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/anewage/tweetycs-api
• Owner: anewage
• Created: 2019-02-20T12:22:36.000Z (over 5 years ago)
• Default Branch: dev
• Last Pushed: 2022-12-10T03:48:47.000Z (almost 2 years ago)
• Last Synced: 2024-10-09T14:50:42.439Z (29 days ago)
• Language: JavaScript
• Size: 2.56 MB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 20
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# tweetycs-api

A simple REST API for tweetycs Project

# Deploy

```bash

# Create config file

mv config/default.js config/local.js

# Edit config file

vim config/local.js

 

# Deploy the service

docker-compose up

```

# Config

Please refer to [this link](https://github.com/lorenwest/node-config/wiki/Configuration-Files)

# Installing

Within the project directory (root folder) issue the following command:

```bash

npm install

```

 OR

```bash

yarn

``` 

# Testing

All the tests are located inside the `__tests__` directory. Tests are being done using [jest](https://jestjs.io/docs/en/getting-started).