Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/jaktestowac/rest-api-demo


https://github.com/jaktestowac/rest-api-demo

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README

        

# Introduction

This application was prepared and developed **only for testing purposes**. It provides:
- GUI
- API

All data (such as users and other entities) are stored in json file.

# Deployment

Instructions how to deploy presented service to various free hosting sites.

* [Deploy to Glitch](#deploy-to-glitch)
* [Deploy to Render](#deploy-to-render)
* [Deploy to Heroku](#deploy-to-heroku)

## Deploy on **Local**

Requirements:
- **node.js** installed in system

Steps:
1. Open project root directory in cmd/terminal
1. Run `npm i`
1. Run `npm run start`

Application will be available at `http://localhost:3000`

## Deploy to **Glitch**
No account needed - but your project will be deleted in 5 days.

After clicking button below wait a minute or two to finish deployment.

[![Remix on Glitch](https://cdn.glitch.me/2703baf2-b643-4da7-ab91-7ee2a2d00b5b%2Fremix-button-v2.svg)](https://glitch.com/edit/#!/import/github/jaktestowac/rest-api-demo)

To see website:

* go to bottom buttons
* click `🔎PREVIEW`
* choose `👯Preview in a new window`

## Deploy to **Render**

- Create free account on: https://dashboard.render.com/register
- After successfull registration hit the button:

[![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy?repo=https://github.com/jaktestowac/rest-api-demo)

* name your app
* hit `Applay`
* wait a while and click link to project `Rest API Demo`
* click link to open app (under porject name and repository)
* enjoy 750 free hours of service per month

## Deploy to **Heroku**
No free option form Q3 2022

Deploy

Heroku is a ~~free~~ hosting service for hosting small projects. Easy setup and deploy from the command line via _git_.
**Data are not persistent! They will be restored to default state** after shutting down application after 30 mins of inactivity.
If an app has a free web dyno, and that dyno receives no web traffic in a 30-minute period, it will sleep.
More: https://devcenter.heroku.com/articles/free-dyno-hours#dyno-sleeping

###### Pros

* PaaS
* Easy and fast setup
* Free

###### Cons (Free Version)

* Application is shut down after 30 mins of inactivity.
Starts back up when you visit the site but it takes a few extra seconds.