nodasxiros/crud-catalog

Description

A Full-stack web app beer catalog, built with Nest framework and React library.

Installation

Clone repository

$ git clone https://github.com/nodasxiros/crud-catalog.git

Run the set_up bash script provided

# The script creates env file and installs
# api and front dependencies
$ ./set_up.sh

# If you get a permissions error try
# the command below and run the script again
$ chmod 777 set_up.sh

Create a database

Run mysql localy and create an empty database with appropriate configuration (the same configuraiton provided in the env file).

Use the sql dump file instead

If you find it hard to create your own db use the dump provided and import it using either a client or the command line

Run db migrations and seeders (Only if you've not used dump file)

# Change into api/ directory
$ cd api/

# This will run all the migration files
$ npx sequelize-cli db:migrate

# This will run all the seeder files
$ npx sequelize-cli db:seed:all

# Change back to root direcotry
$ cd ..

Run the project

Finally, run yarn command separately for api and front, in different tabs

# First tab
$ cd api/ && yarn start:dev

# Second tab
$ cd front/ && yarn start

Front should be running on localhost:3001 whereas api on localhost:[port in env]

License

The present web app is MIT licensed.