Skip to content
This repository was archived by the owner on Dec 4, 2024. It is now read-only.

MCSP-10/code-theory

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Frontend Capstone


Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

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.

(back to top)

Built With

(back to top)

Visuals

Screen_Shot_2022-02-10_at_15.45.00

(back to top)


Getting Started


Prequisites

Ensure you have the latest version of npm installed

npm install npm@latest -g

(back to top)

Installation

  1. Clone the repo
    git clone https://gitlab.com/m7093/frontend-capstone 
  2. Install NPM packages
    npm install

(back to top)

Commands To Remember


Database Commands:

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

Backend Commands:

cd /backend

# run backend server
npm run dev

Frontend Commands:

cd /frontend
# start React application
npm start

(back to top)

Usage

  • Study Guide
  • Algorithm Familiarization

(back to top)

Roadmap

  • Create all necessary components
  • User authentication
  • Add additional algorithms
  • Mobile-friendly design

(back to top)

Contributing

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!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

(back to top)

Contact

Project Link: https://gitlab.com/m7093/frontend-capstone

(back to top)

Acknowledgements


Empathetic Lions

Core Team

Resources

(back to top)

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 6