https://github.com/stevndegwa/school-timetable-planner
School Timetable planner application
https://github.com/stevndegwa/school-timetable-planner
firebase google-calendar oauth2 reactjs redux-toolkit
Last synced: about 2 months ago
JSON representation
School Timetable planner application
- Host: GitHub
- URL: https://github.com/stevndegwa/school-timetable-planner
- Owner: StevNdegwa
- Created: 2020-10-18T19:20:01.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-10-18T19:33:41.000Z (over 5 years ago)
- Last Synced: 2025-04-10T19:35:59.590Z (about 1 year ago)
- Topics: firebase, google-calendar, oauth2, reactjs, redux-toolkit
- Language: JavaScript
- Homepage:
- Size: 281 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
# Timetable App
To be used for school timetable planning.
## Public link
https://school-timetable-planner.firebaseapp.com/
## Resources (Adobe XD and UI design files, Application documentation)
https://drive.google.com/drive/folders/1E8Pvw-XMPtvWzzwYm-57eRkTl12R4fiE?usp=sharing
## CI/CD
* uses Gitlab CI/CD.
## Front end documentation
* Uses React framework.
* Uses Redux for state management.
* Uses SMACSS (Scalable and Modular Architecture for CSS). for front end architecture.
* Uses styled components to add css to the react components.
> File structure:
* The application code is in the src/app folder.
* The src/app/App.js file contains the Application Router.
* The src/app/components folder contains React components.
* The src/app/containers folder contains React components that have access to the redux state.
* The src/app/features folder contains redux configuration files.
* The src/app/helpers folde contains code to be be shared by application components.
** Every react component has been placed in its own folder. This is a way of documentation and to make it easier to solve future problems.
## Bundling
* Uses webpack module bundler.
## Testing
* Uses Jest and Enzyme for unit testing. The testing is done automatically by GitLab.
## APIs used
* Google API - for connecting to the Google Galendar. It uses OAuth 2.0 for authorization.
* Firebase API - for backend resources.
## Backend
Uses firebase for its its backend needs.