Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cre8stevedev/mycalendrr
MyCalendrr - Building a Multi-User Appointment Manager App using a Postgres Database. Frontend Stack: TypeScript-ReactJS, TailwindCSS and Vite. Backend: Python/Flask, SQLAlchemy with a Monorepo setup.
https://github.com/cre8stevedev/mycalendrr
flask postgres python reactjs
Last synced: 6 days ago
JSON representation
MyCalendrr - Building a Multi-User Appointment Manager App using a Postgres Database. Frontend Stack: TypeScript-ReactJS, TailwindCSS and Vite. Backend: Python/Flask, SQLAlchemy with a Monorepo setup.
- Host: GitHub
- URL: https://github.com/cre8stevedev/mycalendrr
- Owner: Cre8steveDev
- License: mit
- Created: 2024-08-29T20:42:58.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-09-10T14:42:40.000Z (23 days ago)
- Last Synced: 2024-09-27T14:42:03.967Z (6 days ago)
- Topics: flask, postgres, python, reactjs
- Language: TypeScript
- Homepage:
- Size: 3.67 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MyCalendrr - Neon Open Source Starter Kit
MyCalendrr is a powerful open source starter kit for building a multi-user appointment manager application. It uses a Neon Postgres database for efficient data storage and retrieval. The project is my submission for the Neon OSS Starter Kit Challenge on DEV and aims to provide developers with a solid foundation for quickly setting up a ReactJS Frontend and Flask Server Project in developing appointment management applications.
## Features
- Multi-user support: MyCalendrr allows multiple users to manage their appointments efficiently and share links to clients to book appointments.
- Frontend Stack: TypeScript-ReactJS, TailwindCSS, and Vite.
- Backend: Python/Flask and SQLAlchemy and Neon Postgres Database.
- Monorepo setup: This kit follows a monorepo setup, allowing for better code organization and easier collaboration among developers.
- GitHub Actions workflow: Basic setup for GitHub Actions workflow - customizable based on your project needs.
## Getting Started
- Clone the repository:
```bash
git clone https://github.com/Cre8steveDev/Neon_Postgres_Flask_SqlAlchemy_ReactJS_Starter_Kit.git
```
- Install the required dependencies
```bash
# For the frontend
cd client && npm install
# For the backend
cd server && python3 -m venv ./venv
# On Linux Machines
source ./venv/bin/activate
# Install dependencies for the backend
pip install -r requirements.txt
```
## Update Credentials in the .env in the server/ directory
```bash
DEV_BRANCH_NEON_DATABASE_URI=""
MAIN_BRANCH_NEON_DATABASE_URI=""
JWT_SECRET_KEY=""
```
## Start the Project
1. Start the frontend development server: `npm run dev`
2. Start the backend server: `python app.py`
3. Access MyCalendrr in your browser at `http://localhost:3000`
## Contributing
Update coming soon. Till then, happy coding.
## License
MyCalendrr is released under the [MIT License](LICENSE).
## AUTHOR
- Stephen Omoregie: Creator and maintainer of MyCalendrr
## 🙏 Acknowledgements
Thanks to Neon for hosting this challenge and providing an amazing Postgres platform!
Challenge Link:
## Research Materials and Documentation
Python and VsCode can be a bit whacky most times. If after installing a package, and your Vscode is still screaming "I'm Losssst!". Just restart the language server. Ctrl/Cmd + Shift + P then search `Language Server`
1. Flask Migration -
2. Flask SQLAlchemy -
3. Flask Bcrypt -
4. Flask JWT Extended
5. Check out available options for JWT