Skip to content

Latest commit

 

History

History
222 lines (189 loc) · 11.1 KB

README.md

File metadata and controls

222 lines (189 loc) · 11.1 KB
Raw

Welcome to Sudomega
Interactive Sudoku Maintainability Test Coverage Website
🛠 This is home to Sudomega, an online sudoku app geared towards sudoku lovers and people who want to improve their sudoku skills. Learn how to play, upload your own sudoku games, and compete with friends :)

click the dropdown arrow to view information

Read about our Mission
What problem does this application solve?

Current Web-based Sudoku puzzles are clumsy, hard to use, and not visually stimulating or rewarding. Furthermore, few if any offer the able to register on the site and save your puzzle to come back to later. Or choose a difficulty(rendom, easy, medium etc..) and theme (darkmode,city mode etc..) for your puzzle page. Also no other Sudoku Web apps have option to upload a paper sudoku image, bring whole puzzle over to the web and continue playing.


This repo hosts:

Web development & Data Science environments:

Index

click the dropdown arrow to view information

Documentation Index breakdown
⟶ About Sudomega
⟶ Contributors
⟶ Getting Started
⟶ Development Info
⟶ Contributing

📂 For more information, read through our DOCUMENTATIONS

Contributors

🙌 This project exists thanks to all the people who contribute. [Contribute].

click the dropdown arrow to view information

LABSPT11 Contributors
​Jessica Dosseh ​Alexis Anderson ​Carlos Turcios ​Tara Sherman ​Vincent Adeniji
Jessica Dosseh Alexis Anderson Carlos Turcios Tara Sherman Vincent Adeniji
Github Github Github Github Github
LinkedIn LinkedIn LinkedIn LinkedIn LinkedIn

Getting Started

Project Set Up

  • Create a forked copy of this project.
  • Clone your OWN version of the repository in your terminal.
  • git pull to make sure you are uptodate
  • git checkout -b new-branch-name
  • Run yarn to install node_module.
  • Run yarn start to start.

🚀 DO your magic!

Development Info

💾 Tech Stack & API Documentation

  General Tech Stack: {
    HTML | CSS | JavaScript | React | Materi-ui | Axios
  }

click the dropdown arrow to view information

Tech stack in depth
Frontend
Solution: React, React Router, Context
What problems does this solution solve for this specific project?
  • Increases performance.
  • React Router manages the url and declares what will be rendered
  • It is the best of both worlds, integrating both server-side and client-side rendering.
  • Can reuse components
  • Code is stable since it flows in one direction
What are the costs of using this solution?
  • The app has to load fully before it is useful
  • Lots of libraries must be used
  • Folder structure can get complicated
What will you be using for styling and presentation?
  • Material UI, React Styling Components and some 'vanilla' CSS
Backend
Solution: Node, Express, Postgres , Knex
What problems does this solution solve for this specific project?
  • Easy to configure
  • Middleware added for security
  • Large, active support community
  • Benefit of Fullstack JS
  • Supports concurrency
  • Scalable
What are the costs of using this solution?
  • Unstable API due to constant updates lacking backwards compatibility
  • Express error messages can often times be unhelpful
  • Slower performance
  • Relational database structuring
  • Open source
  • Postgres debugging can be difficult
Deployment
Solution: AWS Amplify, Heroku
What problems does this solution solve for this specific project?
  • Great Github integration for allowing branch deployments and predeployment conflict checks.
  • Quick and easy setup, with very little additional code needed.
  • Free deployment.
  • Heroku offers relatively easy Postgres implementation.
  • Scalable
What are the costs of using this solution?
  • We have no control over 'out of house' platforms
  • Relatively low network performance on Heroku
Features Documentation
Landing Page
Login & Registration Page
Game Page
Tutorial Page
Upload Puzzle
About us Page
Dark and Light Mode
Deployed Frontend https://console.aws.amazon.com/amplify/
Deployed Backend https://omega2020.herokuapp.com/
DS Puzzles API postgres://postgres:omega2020database@omega2020.cbydc0au6atn.us-east-2.rds.amazonaws.com:5432/postgres
DS Computer Vision (Upload) API https://api.lambda-omega2020.com/demo_file

🐞 Bugs and Issues: Bug Documentation

🤝 Contributing

Omega 2020 is a community project. We invite your participation through issues and pull requests! You can peruse the contributing guidelines.

When adding or changing a service please add tests.

This project has quite a backlog of suggestions! If you're new to the project, maybe you'd like to open a pull request to address one of them: