/Tucana.app

Tucána | Share your rides in Costa Rica

Primary LanguageJavaScript

If you want to participate in the code, first, thank you for your contribution, then please follow these instructions to set up your environment:

Requirements:

  • NodeJS

1 - Set up the database

  • Download and Install pgAdmin: https://www.pgadmin.org/download/
  • Create a database. Please take notes of the following info:
    • Database host URL
    • Database port
    • Database name
    • Database user
    • Database password

NB: usually, when installing pgAdmin, the database URL is: localhost, port is 5432, user is postgres.

  • Let pgAdmin run in the background

2 - Prepare the Back-End

REACT_APP_URL_CLIENT=
REACT_APP_URL_API=[URL]/api
REACT_APP_GOOGLE_MAPS_API_KEY=

DATABASE_HOST=
DATABASE_PORT=
DATABASE_USERNAME=
DATABASE_NAME=
DATABASE_PASSWORD=

ADMIN_EMAIL=admin@tucana.app
ADMIN_FIRSTNAME=Admin
ADMIN_LASTNAME=Tucána
ADMIN_PASSWORD=123456
ADMIN_USERNAME=admin

MODO_EMAIL=modo@tucana.app
MODO_FIRSTNAME=Modo
MODO_LASTNAME=Tucána
MODO_PASSWORD=123456
MODO_USERNAME=modo

SUPPORT_EMAIL=info@tucana.app
SUPPORT_FIRSTNAME=Support
SUPPORT_LASTNAME=Tucána
SUPPORT_PASSWORD=123456e
SUPPORT_USERNAME=support

SALES_EMAIL=sales@tucana.app
SALES_FIRSTNAME=Sales
SALES_LASTNAME=Tucána
SALES_PASSWORD=123456
SALES_USERNAME=sales

USER_PASSWORD=
PASS_PHRASE=

Check out an example of a .env for the Back-End at the bottom of this explanation.

  • Install the dependencies: npm install && npm install --only=dev
  • Run the Sequelize command to populate the Database
    • npx sequelize db:migrate && npx sequelize db:seed:all
  • Start the dev server: npm dev

3 - Run the Front-End

REACT_APP_URL_CLIENT=
REACT_APP_URL_API=
REACT_APP_GOOGLE_MAPS_API_KEY=
REACT_APP_GOOGLE_RECAPTCHA_SITE_KEY=
REACT_APP_GOOGLE_RECAPTCHA_SECRET_KEY=

Check out an example of a .env for the Front-End at the bottom of this explanation.

  • Run npm install && npm install --only=dev
  • Start the dev app: npm run dev

Contribute

You can now use the app with different credentials:

  • user: alex
  • password: 123456

  • user: peter
  • password: 123456

  • Etc.

NB: You can find all the default users in the seeder file named 20210716125238-users.js in the Back-End in the ./seeders/ folder in the root of the project.

Further notes:

  • We do not provide Google Maps API keys and Google Captcha API keys.
  • A PostgreSQL testing database is not available online yet.
  • In dev mode, the back-end app is not sending emails. So if you are creating accounts and want to confirm them, find the confirmation link looks like "http://localhost/confirm/UUID".

Example of a Back-End .env file:

These data are not exhaustive, they are shown as an example

REACT_APP_URL_CLIENT=http://localhost:3000
REACT_APP_URL_API=http://localhost:5000/api
REACT_APP_GOOGLE_MAPS_API_KEY=[YOUR_GMAPS_API_KEY]

DATABASE_HOST=localhost
DATABASE_PORT=5432
DATABASE_USERNAME=postgres
DATABASE_NAME=tucana
DATABASE_PASSWORD=123456

ADMIN_EMAIL=admin@tucana.app
ADMIN_FIRSTNAME=Admin
ADMIN_LASTNAME=Tucána
ADMIN_PASSWORD=123456
ADMIN_USERNAME=admin

MODO_EMAIL=modo@tucana.app
MODO_FIRSTNAME=Modo
MODO_LASTNAME=Tucána
MODO_PASSWORD=123456
MODO_USERNAME=modo

SUPPORT_EMAIL=info@tucana.app
SUPPORT_FIRSTNAME=Support
SUPPORT_LASTNAME=Tucána
SUPPORT_PASSWORD=123456
SUPPORT_USERNAME=support

SALES_EMAIL=sales@tucana.app
SALES_FIRSTNAME=Sales
SALES_LASTNAME=Tucána
SALES_PASSWORD=123456
SALES_USERNAME=sales

USER_PASSWORD=123456
PASS_PHRASE=ehLLg$#5YtT@V6gQinXX

Example of a Front-End .env file:

These data are not exhaustive, they are shown as an example

REACT_APP_URL_CLIENT=http://localhost:3000
REACT_APP_URL_API=http://localhost:5000/api
REACT_APP_GOOGLE_MAPS_API_KEY=[YOUR_GMAPS_API_KEY]
REACT_APP_GOOGLE_RECAPTCHA_SITE_KEY=[PUBLIC_KEY]
REACT_APP_GOOGLE_RECAPTCHA_SECRET_KEY=[SECRET_KEY]