Table of Contents
This application serves as an educational tool for developers and students to visualize how algorithms work. Many people find algorithms a difficult concept to fully understand, especially when current resources are mostly text-based. As a team, we decided to contribute to open source learning with an easy-to-navigate website that allows users the ability to experiment with different algorithms and communicate with other like-minded individuals.
Ensure you have the latest version of npm installed
npm install npm@latest -g
- Clone the repo
git clone https://gitlab.com/m7093/frontend-capstone
- Install NPM packages
npm install
cd /backend
# create migration file
npm run migrate:make [table_name]
# creates/updates tables
npm run migrate
# create seed files
npx knex seed:make [seed_file_name] --knexfile db/knexfile.js
# run seed files
npm run seed
# rollback migration (so you can reset tables in database and reseed)
npm run rollback
cd /backend
# run backend server
npm run dev
cd /frontend
# start React application
npm start
- Study Guide
- Algorithm Familiarization
- Create all necessary components
- User authentication
- Add additional algorithms
- Mobile-friendly design
Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Project Link: https://gitlab.com/m7093/frontend-capstone