Skip to content

Latest commit

 

History

History
223 lines (165 loc) · 7.01 KB

README.md

File metadata and controls

223 lines (165 loc) · 7.01 KB
Raw

Dashboard App

Contributors Forks Stargazers Issues LinkedIn


Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. Contact
  7. Acknowledgments

About The Project

(Back to top)

Built With

  • Node
  • Postgres
  • Heroku

(Back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

Things you need to use the software and how to install them.

  • npm 
    npm install npm@latest -g
  • yarn 
    npm install --global yarn

Installation

  1. Clone the repo 
    git clone https://github.com/dylan751/dashboard-backend.git
  2. Install packages and dependencies (yarn) 
    yarn install
  3. Create a .env.local file, enter your API in .env.local 
    POSTGRES_USER = 'POSTGRES_USER';
POSTGRES_HOST = 'POSTGRES_HOST';
POSTGRES_DB = 'POSTGRES_DB';
POSTGRES_PASSWORD = 'POSTGRES_PASSWORD';
POSTGRES_PORT = 'POSTGRES_PORT';
JWT_SECRET = 'ZUONG_SECRET';
PGSSLMODE = 'no-verify';

(Back to top)

Usage

How this project can be used. Additional screenshots, code examples and demos. You may also link to more resources.

For more examples, please refer to the Documentation

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

yarn start:dev

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.
You may also see any lint errors in the console.

yarn build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

(Back to top)

Roadmap

  • Authentication / Users
  • CRUD Feature
    • CRUD Tour
    • CRUD Destination
    • CRUD Booking Form
    • CRUD Reviews
  • Shoppint Cart Feature
  • Blog Feature

See the open issues for a full list of proposed features (and known issues).

(Back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(Back to top)

Contact

Nguyen Hai Duong - @facebook_handle - muoi07052001@gmail.com

Project Link: https://github.com/dylan751/dashboard-backend

(Back to top)

[WIP] Acknowledgments

(Back to top)