Skip to content

LoS-Light/UserRestaurants

Repository files navigation

UserRestaurants

"UserRestaurants" manages your delicious restaurant list.

Features

  • Sign up
  • Login by (username & password) or oauth2
  • Display restaurants on multiple pages
  • Search restaurants by name or category
  • Reorder restaurants
  • Flash messages
  • Create a new restaurant
  • Check restaurant information
  • Edit restaurant information
  • Delete restaurant information

Environment requirements

  • Node.js v18
  • MySQL server v8

Installation

  1. Clone the repository
git clone https://github.com/LoS-Light/UserRestaurants.git

  1. Move to the UserRestaurants directory
cd UserRestaurants

  1. Restore the dependencies
npm install

  1. Create example environment configs
npm run env:create

  1. Launch Mysql Server

Launch your mysql server, and edit environment config files in folder "env".
There are two config files in it, ".env.development.local" and ".env.production.local".
Change the "DB_MYSQL_USERNAME", "DB_MYSQL_PASSWORD", "SESSION_SECRET" to match your mysql server connection settings.


  1. Create a new database and seed test data.
npm run db:create
npm run seed

  1. Launch the application

Run app in development mode

npm run dev

or

Run app in production mode

npm run build
npm run start

In your browser, open http://localhost:3000 to see the website.


  1. Login by oauth2 (Optional)

Edit environment config files in folder "env".
There are two config files in it, ".env.development.local" and ".env.production.local".
Change items below to match your account settings.

OAUTH2_FACEBOOK_CLIENT_ID
OAUTH2_FACEBOOK_CLIENT_SECRET
OAUTH2_GOOGLE_CLIENT_ID
OAUTH2_GOOGLE_CLIENT_SECRET

Demo

https://userrests.loslight.com

Screenshots

image image image

License

This project is licensed under the MIT License - see the LICENSE.md file for details

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published