Skip to content

Latest commit

 

History

History
187 lines (145 loc) · 7.97 KB

README.md

File metadata and controls

187 lines (145 loc) · 7.97 KB
Raw

Contributors Stargazers Issues MIT License


Logo

Task Organizer

This is our final project for CS 364: Introduction to Database Management Systems at the University of Wisconsin - La Crosse. It is a small taks management application written in nodejs and react with a mariadb database for storage.
Authors: Connor Marks and Bennett Wendorf
Explore the docs »

Report Bug · Request Feature

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

About The Project

The idea for this project comes largely from something that we, as students and software developers, are intimately familiar with. The need for most individuals and teams to have some way to manage their tasks on a given project, class, or day is something that many if not all students and developers have had to struggle with. Our goal with this project is to create a good solution for managing tasks for whatever use case our users might need. We also included a more overarching idea of a project that tasks can be a part of. This would be especially useful for teams that are working on multiple projects to help them organize what they need to work on and what those individual tasks are a part of. Much of the inspiration for how to format this project comes from Microsoft To Do. Microsoft To Do is a task management software that allows management of tasks for a single user. One of our main goals was to take this idea and expand on it to allow management of tasks for multiple projects as well as teams of people. We chose to implement this as a web app so that it can conceivably be run on cloud infrastructure and be accessed from anywhere. In theory, this structure would also allow us to easily implement a mobile app as a secondary platform for accessing the same data. We wanted to provide a fully functional task management system that one could easily use to provide task and project management functionality for a single user, all the way up to a large team with a clean UI and easy access to all the data one might need.

Built With

This project is written in Node.js for the backend and React.js for the frontend, with the use of some other packages to aid development.

Getting Started

For now, there is no installer or prepackaged installation for this project. Follow the instructions below to get the project running on your system.

Installation

  1. Clone the repo

    git clone https://github.com/Bennett-Wendorf/SQL-Project.git

  2. Install dependencies

    • In the frontend directory use npm to install the requirements for the frontend. 
      cd frontend
npm install
    • Then do the same for the backend. 
      cd ../backend
npm install

    OR

    • If you wish to use the application as is, you only need to install the backend requirements, as the build directory in the backend will host the pages for the frontend.

  3. Run the app

    • If you wish to run the prebuilt frontend from the backend, you can do the following to run the backend server and host the frontend from it. 
      cd backend
npm start

    OR

    • If you wish to run the backend and frontend separately, do the following in two separate terminals: 
      cd frontend
npm start
      cd backend
npm run dev OR npm start

  4. Create your own frontend build

    • You can also check out this guide on how to create that build folder if you make modifications to the frontend.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  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

If you find an issue in existing code, feel free to use the above procedure to generate a change, or open an issue for me to fix it.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Bennett Wendorf - Website - bennettwendorf@gmail.com

Project Link: https://github.com/Bennett-Wendorf/SQL-Project

Acknowledgements