Data Royale

Group Project for 14:332:452 - Software Engineering
Demo Videos
Demo 1 Demo 2

Initial Setup Steps

• Open up an editor of your choice
• Make sure you have NPM, NodeJS, Git installed
• Also install MAMP (https://www.mamp.info) for the Database
• Open up your terminal and cd \my\folder\directory\
• Run git init followed by git clone https://github.com/Herxity/SWE2024.git
• Run npm install
• For all third-party services (Team 4), create a .env file in your current directory with the following format:
  STRIPE_SECRET_API_KEY=
  STRIPE_PUBLIC_API_KEY=
  MJ_APIKEY_PUBLIC=
  MJ_APIKEY_PRIVATE=
• Create accounts for both Stripe (https://stripe.com/) and Mailjet (https://app.mailjet.com/)
• You can find the stripe keys here: https://dashboard.stripe.com/test/apikeys
• You can find the Mailjet keys here: https://app.mailjet.com/account/apikeys

Docker compose setup

• Install docker
• If docker is not started put command sudo systemctl start docker or sudo service docker start
• Assuming you have docker installed on linux (Ubuntu 20.04 LTS preferred). You should be able to simply run docker compose up --build This step should automatically configure a MySQL database container. If for whatever reason this fails please see the steps that follow:

Set Up Database

• Start up MAMP, and click "Start Servers". Then, navigate to this link: http://localhost/phpMyAdmin/?lang=en
• Click "Import", and upload the database found in database/swe2024. Press "go" at the bottom of the page to complete the action. This database contains all of the tables you'll need for this project
• Run npm run server to start up your server on port 3000
• Navigate to http://localhost:3000/ in your browser and you should see a message
• Refer to the code in backend/routes and backend/controllers for more complex requests

NOTE: If the server errors out saying something along the lines of that it cannot connect to the database, please ensure the db.js file has the correct port in use.

Set Up Payments/Subscriptions

• For testing: npm run payment-test (make sure to CTRL+C after to leave the asynchronous server loop)
• The API is also available for you to use according to the demo video.
• The Notifications system is currently being integrated into the API, to run it, you can find the file /backend/utils/. Ensure you change the email fields to valid ones, and please do not spam.

Set up Competition Management

• For testing: npm run competition-test (make sure to CTRL+C after to leave the asynchronous server loop)
• The API is also available for use according to the demo video.

Some footnote commands

For starting the db container for testing without docker compose use docker run -d -p 3001:3306 db Note, we need a bridge network named swe2024_my-bridge-network for successful running of this application as the user containers will all connect to it for IP assignment.

for using sql

docker exec -it swe2024-db-1 bash mysql -u root -p (password root) use swe2024