Before getting started, you'll need these global packages to be installed:
First, you'll need to make a fork of the LogChimp repository. Click on the fork button right at the top, wait for a copy to be created over on your personal GitHub account, and you should be all set!
Once you will run the command at the root of the repository, it will install all the required dependencies for both frontend and backend.
There are two ways to set up a local development.
You can choose any option you prefer. Just make sure, you are running a Postgres database on v12.
To set up a database quickly and easily, we suggest you run a Postgres docker container.
docker run -d \ --name db \ -p 5000:5432 \ -e POSTGRES_DB=database_name \ -e POSTGRES_USER=database_user \ -e POSTGRES_PASSWORD=strong_password \ postgres:12.4
Once you take down the Postgres Docker container all the data is also removed, to persist the data on your machine, you can add this line.
At the root of the repository, you will find a file name
.env.example, rename the file to
.env, and update the values of the variables.
# node environment NODE_ENV="development" # database PG_USER=database_user PG_HOST=localhost PG_DATABASE=database_name PG_PORT=5000 PG_PASSWORD=strong_password
.env file inside
frontend directory and replace
$SERVER_PORT with port number the backend is running on.
# client VUE_APP_SEVER_URL="http://localhost:$SERVER_PORT"
.envis not really a best option. We've created an issue to ask other developers for help on that.
You need two separate terminal windows to run frontend and backend.
# in terminal 1 yarn run frontend:dev # in terminal 2 yarn run server:dev