RakibulRanak / StoryBook-Backend

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

StoryHub backend

About

This repository serves as a backend for my StoryHub applcation which is a fullstack internship learning project at CEFALO. You can visit the frontend part here.

Getting Started

To get the Node server running locally:

  • Clone this repo

  • npm install to install all required dependencies

  • create an .env file in the root folder containing following variables :

    .env file

  • npm start to start the local server

  • npm test to run the test files

Alternately, you can visit the web app at https://story-book.cyclic.app/

Description

StoryHub is mainly a simple blogging web app, where a random person can become an user by signing up with email, username, name and password. A user can post story with a valid title, and content. Users can also edit or delete their respective stories while logged in.

Tools and Technologies

I have used a remote PostgreSQL database service (https://www.elephantsql.com/ )

  • expressjs - The server for handling and routing HTTP requests
  • jsonwebtoken - For generating JWTs used by authentication
  • pg - As a PostgreSQL client for Node.js
  • sequelize - As a promise-based Node.js ORM tool for PostgreSQL
  • cors - For enabling CORS with various options.
  • jest - As a testing framework.

and others.

Api Documentation

Dockerization & Deployment

About


Languages

Language:JavaScript 98.5%Language:HTML 1.3%Language:Dockerfile 0.2%