https://github.com/abayo-luc/readit

https://github.com/abayo-luc/readit

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/abayo-luc/readit
• Owner: abayo-luc
• License: mit
• Created: 2019-01-28T13:26:37.000Z (over 6 years ago)
• Default Branch: develop
• Last Pushed: 2019-05-12T19:14:07.000Z (about 6 years ago)
• Last Synced: 2025-01-27T09:09:50.513Z (4 months ago)
• Language: JavaScript
• Size: 317 KB
• Stars: 0
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# READIT NodeJs/Express application

## Description

3-5 sentences describing the code and what it's purpose is

## Documentation

List of endpoints exposed by the service

### Getting Started

### Get the latest version

```https://github.com/abayo-luc/readIt.git```

### Change directory

```cd readit```

### Update the environments variables in sample.env file and rename it to '.env'

```mv sample.env .env```

### Install the dependencies 

```yarn```

### Start the application

````yarn server````

### Testing

`yarn test`

## Contribute

Any instructions needed to help others contribute to this repository

## Deployment

Step by step instructions so that the developer can understand how code gets updated