Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sakhileln/skillsync

A Python-based Command-Line Interface (CLI) application for managing workshop bookings and one-on-one meetings. 🔥🫱🏾‍🫲🏽
https://github.com/sakhileln/skillsync

click firebase firebase-admin firebase-auth firebase-database google-calendar google-calendar-api pyinstaller

Last synced: 3 days ago
JSON representation

A Python-based Command-Line Interface (CLI) application for managing workshop bookings and one-on-one meetings. 🔥🫱🏾‍🫲🏽

Awesome Lists containing this project

README

        

# SkillSync 🔥
A Python-based Command-Line Interface (CLI) application for managing workshop bookings and one-on-one meetings. The system uses Firebase for authentication and database management and integrates the Google Calendar API for scheduling.

## Table of Contents
- [Features](#features)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
- [Acknowledgments](#acknowledgments)
- [Contact](#contact)

## Features
- Authentication
- Booking System
- Google Calendar Integration
- CLI Functionality
- Firebase

## Prerequisites
Before you begin, ensure you have the following installed on your system:
- Python 3.8 or higher
- Poetry (for dependency management) or `pip`

## Installation
- Copy the project to your computer.
```bash
git clone https://github.com/sakhileln/SkillSync
```
- Change directory to the project folder.
```bash
cd SkillSync
```
- To run the project
```bash
python3 skillsync.py
```
- Follow the command line prompts.

## Usage
- Start the program.
```bash
python3 skillsync.py
```
- Get help for how to run the program
```bash
python3 skillsync.py -h
python3 skillsync.py view-bookings -h
python3 skillsync.py login -h
python3 skillsync.py cancel-booking -h
```
- **Follow the command line prompts**

## Contributing
Contributions are welcome! If you'd like to contribute. See the [CONTRIBUTING](CONTRIBUTING.md) file for details.
1. Fork the repository.
2. Create a new branch for your feature/bug fix:
```bash
git checkout -b feature/YourFeature
```
3. Make your changes and test thoroughly.
4. Submit a pull request explaining your changes.

## License
This project is licensed under the GNU GPL v3.0 License. See the [LICENSE](LICENSE) file for details.

## Acknowledgments
- [Datetime](https://docs.python.org/3/library/datetime.html)
- [Pickle](https://docs.python.org/3/library/pickle.html)
- [Google Calendar API Python quickstart](https://developers.google.com/calendar/api/quickstart/python)
- [Domain-wide delegation](https://developers.google.com/classroom/guides/key-concepts/domain-wide-delegation?hl=en)
- [Invite users to an event](https://developers.google.com/calendar/api/concepts/inviting-attendees-to-events)
- [Create events](https://developers.google.com/calendar/api/guides/create-events)
- [click](https://click.palletsprojects.com/en/stable/)
- [pyrebase](https://github.com/thisbejim/Pyrebase)
- [Python Pickle Tutorial](https://www.datacamp.com/tutorial/pickle-python-tutorial)
- [Events](https://developers.google.com/calendar/api/v3/reference/events/delete#python)
- [Google Calendar API Docs](https://www.postman.com/postman/google-api-workspace/documentation/54xuf9z/google-calendar-api)
- [Firebase Authentication](https://firebase.google.com/docs/auth)
- [Firebase Build Projects](https://firebase.google.com/docs/build)
- [Firebase Realtime Database](https://firebase.google.com/docs/database)

## Contact
If you have any questions or suggestions, feel free to open an issue in this repository or contact us directly.
- Sakhile III
- [LinkedIn Profile](https://www.linkedin.com/in/sakhile-ndlazi)
- [GitHub Profile](https://github.com/sakhileln)