ScheduleMaker

A webtool designed to help your small business keep track of your employee's schedules!

1. Built With
2. Prerequisites
3. Installation
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

• ScheduleMaker is a CRUD application designed to help employers easily manage their staff's schedules.
• ScheduleMaker uses industry standard technologies like React, Django, and SQL, to securely manage and store scheduling data

(back to top)

-->

Built With

• 
• 
• 

(back to top)

Prerequisites

• Node
• npm
• Django

Installation

1. Clone the repo

   git clone https://github.com/isaaclee12/ScheduleMaker.git

2. Run the app (npm install will be performed automatically, and the server and client will be run concurrently) npm start

NOTE: CRUD functionalities take a minute to load on launch

(back to top)

Roadmap

• PHASE 1: CRUD Functionality

  • Implement Create/Read/Update/Delete pipelines
  • Add UI + Forms to reflect these pipelines
  • Migrate database to ElephantSQL
  • Phase Completed!

• PHASE 2: Dates + Glow Up

  • Create dummy data for future weeks from today through the next year so the app just works.

  • Fix updateShiftForm to make sure it gets the data for the shift @ id again

  • Deploy

  • Change Update + Delete Shift functionality from being separate pages to making buttons visible

    • And make sure both buttons don't appear at the same time. Add a cancel button too.

  • Add date-fns features to have a front page that stays at the current week.

  • Add ability to go between weeks.

  • Refactor the code to have better code patterns.

  • Bolster backend security.

  • Aesthetics:

    • Mobile responsiveness
    • Better CSS please!
    • Dark Mode

• PHASE 3: Authentication & Data Cleaning

  • Implement Basic JWT Authentication for a single account
  • Add change password/change email system
  • Add Roles System
  • Have one admin account and a few employee accounts
  • Have schedules displayed based on who's logged in
  • Document the whole thing

• Phase 4: Add availability, time off, and other features

  • Add availability (2 weeks out, for employees, any for managers)
  • Add time off (2 weeks out, for employees, any for managers)
  • Add other features in notebook
  • MVP Complete!

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. 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

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

(back to top)

Contact

Isaac Lee - @isaaclee12 - [email protected]

Project Link: https://github.com/isaaclee12/ScheduleMaker

(back to top)

About the Data:

• id (int): ID of row
• day_of_week (string): Day of the week the shift occurs, e.g. Monday, Tuesday, etc.
• date (date): The date the shift occurs in ISO 8601 format, e.g. 2000-01-01
• name (string): The name of the employee who is working the shift
• position (string): The position that the employee will be working in
• location (string): The location of the store. Useful if a business has multiple locations.
• start_time (string): The starting time of the shift.
• end_time (string): The ending time of the shift.
• total_hours (int): The duration of the shift in hours. Should equal the time between start_time and end_time.

(back to top)