Groupmates: Linhao He, Jack Williams, Nghia Pham
Our project goal is to design and implement a web app music player along with its own dedicated database. We want to have a secure login to the website, which will then take you to a homepage which you can navigate through recommended and popular songs. You can also go to your own playlists.
Client-Server / N-tier architecture, built with Open Closed principle in mind.
- Version Control: Git
- Scrum board: Github
- Front-end:
- Framework: built using React OOP class structure with props and data manipulation to represent our UI
- Language: JavaScript, HTML, CSS
- Library: Material UI, React Router, React Redux, Axioms
- Framework: Express.js
- Language: JavaScript, SQL
- Library: Sequelize ORM
- Database: SQL
- Install Git if you don't already have it installed
- Clone the repository to your Desktop (or desired file directory)
git clone https://github.com/jackwilliams2480/Echo - Install Docker on your machine
- Note: If you have a prevous build, run
docker system prune -ato remove it. Beware that this removes all docker containers that exist on your computer, not only echo. - Open up a terminal on your computer, and navigate to the Echo project directory
- From here run
docker-compose up --build -d--buildcreates containers if they do not already exist-dallows for us to detach the docker process in order to more easily troubleshoot errors
- Once Docker has completed its build and setup, you now have access to the complete build of the project
- We can now access the Echo webapp from http://localhost:3000
- Note: to access the main page without login navigate to http://localhost:3000/home
- To get an overview of the api, navigate to http://localhost:8000/api-docs
- After Build, open echo_server CLI
- From container CLI, run
npm test
- While still in the same Echo directory, run
docker-compose down