/FinalProject-Backend-DevInit

Final project of Dev Init #2 Backend Developer Track.

Primary LanguageTypeScript


Logo

Era Planner (Backend)

Make your life easier by plan your life in this awesome web application!

View Demo

Table of Contents
  1. About The Project
  2. Getting Started
  3. Test Report
  4. License
  5. Contact

About The Project

Era Planner is the Front-end project that have concept of managing daily life. You can locate the Era Planner Front-end Repository here : [GitHub Repo](https://github.com/Celesca/FinalProject-Frontend-DevInit)

For this project is the new chapter or the Backend server for the old project which is from the Dev Init Program too.

There are several endpoints of feature you can use:

  • User endpoints
  • Todo-list endpoints
  • Daily Log endpoints
  • Event endpoints

(back to top)

Built With

  • Express (TypeScript)
  • PostgreSQL
  • Jest.js

(back to top)

Getting Started

First you need to setting up your locally folder. To get a local copy up and running follow these simple example steps.

Prerequisites

This is how to list things you need to use the software and how to install them via npm.

  • npm 
    npm install npm@latest -g

Installation

Following the guide from below through your terminal.

  1. Clone the repo 
    git clone https://github.com/Celesca/FinalProject-Backend-DevInit
  2. Move to folder directory 
    cd FinalProject-Frontend-DevInit
  3. Install NPM packages 
    npm install
  4. Run the backend server (Port 3000) 
    npm run dev
  5. Start database server with docker (Port 5432) 
    docker-compose up --build

(back to top)

Test Report

Test cases will be in the following images (Credit by Borntodev)

Automate Testing using Jest.js

npm test

Videos about touring this project

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Linkedin - Sawit Koseeyaumporn

Project Link: EraPlanner

(back to top)