Skip to content

hmungiria/cs4273-group-I

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

117 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CS4273 Group I

Project Overview

Our project constructs an public Oklahoma missing persons database, keeping information such as photos, demographics, and last contact information, and search and export functionality. Found cases are deleted to adhere to laws.

Technologies Used

Note: The live version of Missing Persons is no longer available, as the hosting credits for Railway, Vercel, and AWS have expired. While the application is not currently deployed, you are welcome to explore the source code in this repository. Database setup for this project has been provided in the .sql and can be imported. Docker will need to have updated host settings but If you'd like to run the project locally, setup instructions are provided below.

MySQL

Since our project heavily relies on a database to display our information the database chosen needs to be able to handle a large amount of data efficiently. It also needs to be able to filter data and sort it. These factors led us to choose an SQL-based database and we decided on MySQL to be a good choice as it is a free option that seemed to offer good scalability.

Next.js

To build a responsive and dynamic front-end, we chose Next.js, a popular React framework. It provides server-side rendering capabilities for improved performance, and allows for the creation of a highly interactive user interface that adapts seamlessly to various device types. This will be good for our project as it allows the users to quickly search for the missing persons they care about.

Docker

We chose Docker because our team works on different operating systems, and Docker enables us to simplify deployment, ensuring consistency across all devices. Additionally, Docker’s scalability makes it an excellent choice, allowing our database and application infrastructure to grow seamlessly as our project expands.

Dependencies

Latest version of Node.js, or docker.

Setup Instructions

  1. Clone the repository with git clone https://github.com/cth2x/CS4273_Group_I.git
  2. Navigate to the project directory.
cd CS4273_Group_I

Without docker

  1. Install dependencies:
npm install
  1. Run development website
npm run dev

With docker

  1. Start docker image
docker compose up
  1. Install deps
docker exec -it name_of_container sh -c "npm install"

Note:

The following environment variables must be set if running with node, or edited in the docker-compose.yml if using docker.

MYSQL_HOST
MYSQL_USER
MYSQL_PASSWORD
MYSQL_DATABASE

Website

After following the above steps view the website at http://localhost:3000

Team Contributers

Mel Fillmore - Mentor

Noah Zinn - Product Owner

Cole Hicks - Quality Assurance

Carson Siemens - SM1 Tyler Vuong - SM2

Muhammad Ali - SM3

Connor Corbin - SM4

Progress Plan

  • Setup simple frontend page with JS.
    • Choose what library we want to import the data table from, or make a table from scratch.
    • Use data from CSV to fill the data table.
  • Review features needed with the mentor
    • Show demo of frontend, decide if any feature is missing, and update demo as needed
  • Setup backend database based on requirements
  • Connect database to frontend, host site on docker
  • Connect individual missing person page
  • Incorporate Admin authentication and permissions
  • Improve UI
  • Develop add/remove a person from frontend
  • Check for any bugs, and show the product to the mentor to see if any changes need to be made

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages