Edmonton

Welcome to the Edmonton project repository!

Requirements

Before you begin, ensure you have met the following requirements:

• Node.js and npm

  • To check that nodejs is installed run

    node --version

  • to check that npm is installed run

    npm --version

  • Since we will deploy our app in a server that has node v14, we will be using nodejs v14 for this project

• XAMPP with MySQL

Installation

1. Clone the repository:

   git clone https://github.com/eugenesang/edmonton.git

2. Navigation to project

   cd edmonton

3. Install dependencies

   npm install

4. Create and configure the database:

   Open MySQL Workbench or your preferred MySQL client (XAMPP for our case). Create a new database (if not already created).

   • Environment variables
   1. Create a file named .env
   2. In the file, add and/or update with appropriate values

   DB_HOST= #i.e localhost
   DB_USER= #mysql user i.e admin or root
   DB_PASSWORD= #mysql password
   DB_DATABASE= #mysql database name
   SESSION_SECRET = # at least 16 character long alphanumeric string of characters
   PORT = # i.e 2354
   JWT_SECRET = # at least 16 character long alphanumeric string of characters

   # is a comment in .env file, so remove them in your the file

5. Check that everything is configured, including:

   • Database
   • Modules (Project directory should include: node_modules folder and package-lock.json file)
   • .env file exists and its contents are correct
   • port 2354 is not hosting another event

Usage

To run the application, use the following command:

npm start

By default, the application will be accessible at http://localhost:2354

License

This project is licensed under the MIT License.

Future versions

• Future version will use MongoDB in place of mysql
• We are shipping our code to use react for frontend
• In other words we are migrating to MERN