Welcome to the View Roster project! This project aims to provide a simple and efficient way to record, view and manage roster entries. User can sign up/in and easily add, edit, and clear hour blocks for each roster entry, in a week view layout.
- Record and view current, past, and future roster entries
- Add, edd and clear hour blocks for each roster entry
- Sign up/in to access and manage roster entries
- Get total hours worked in each week to help with payroll, time management, and work restrictions
The View Roster project requires the following dependencies:
- Frontend: HTML5, CSS3, JavaScript ES6, React.js
- Backend: Node.js, Google Cloud Platform (Firebase)
- Database: Firestore (NoSQL)
- Authentication: Firebase Authentication
- Hosting: Firebase Hosting
- Version Control with CI/CD: GitHub, GitHub Actions
To get started with the View Roster project, follow these steps:
- Clone the repository to your local machine.
- Install the necessary dependencies:
node.js,npm,firebase-tools - Get
firebase-config.jsafter setting up a Firebase project and add it to thesrcfolder.
Note: The
firebase-config.jsfile should contain the Firebase configuration object, for example:
export const firebaseConfig = {
apiKey = <API_KEY>,
...
};- Run the application using the following command:
npm start
Once the application is up and running, you can access the roster view by navigating to the provided url. From there, you can perform various actions such as viewing, adding, and clearing roster entries.
Contributions are welcome! If you would like to contribute to the View Roster project, please follow these guidelines:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and commit them.
- Push your changes to your forked repository.
- Submit a pull request.
This project is licensed under the GNU General Public License v3.0. For more information, see the LICENSE file.
Email: manoj.shrestha8080@gmail.com
