https://github.com/iamsjunaid/tasks
A simple task management application built with FastAPI for the backend and React for the frontend. The backend uses Firebase Realtime Database for data storage and management.
https://github.com/iamsjunaid/tasks
fastapi fastapi-sqlalchemy firebase javascript python reactjs render tailwindcss vercel-deployment
Last synced: 6 months ago
JSON representation
A simple task management application built with FastAPI for the backend and React for the frontend. The backend uses Firebase Realtime Database for data storage and management.
- Host: GitHub
- URL: https://github.com/iamsjunaid/tasks
- Owner: iamsjunaid
- License: mit
- Created: 2024-07-15T11:20:23.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-18T02:32:42.000Z (over 1 year ago)
- Last Synced: 2025-01-13T14:53:28.717Z (about 1 year ago)
- Topics: fastapi, fastapi-sqlalchemy, firebase, javascript, python, reactjs, render, tailwindcss, vercel-deployment
- Language: JavaScript
- Homepage: https://tasks-vert.vercel.app/
- Size: 396 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Task Management App
A simple task management application built with FastAPI for the backend and React for the frontend. The backend uses Firebase Realtime Database for data storage and management.
## Features
- Create, update, and delete tasks.
- View all tasks in a tabular format.
- Update task status with a modal form.
- Responsive design with Tailwind CSS.
## Getting Started
### Prerequisites
- Node.js and npm installed on your machine.
- Python and pip installed on your machine.
- Firebase account with a Realtime Database set up.
### Installation
1. Clone the repository:
```bash
git clone https://github.com/iamsjunaid/tasks.git
cd tasks
```
2. Set up the backend:
a. Navigate to the backend directory:
```bash
cd backend
```
b. Create a virtual environment and activate it:
```bash
python -m venv venv
source venv/bin/activate # On Windows, use `venv\Scripts\activate`
```
c. Install the required dependencies:
```bash
pip install -r requirements.txt
```
d. Create a `.env` file in the backend directory with your Firebase credentials:
```plaintext
SERVICE_ACCOUNT_KEY='{
"type": "service_account",
...
}'
```
e. Run the FastAPI backend:
```bash
uvicorn main:app --reload
```
3. Set up the frontend:
a. Navigate to the frontend directory:
```bash
cd frontend
```
b. Install the required dependencies:
```bash
npm install
```
c. Run the React frontend:
```bash
npm start
```
## Deployment
### Firebase
1. Create a Firebase project and set up a Realtime Database.
2. Download the service account key JSON file from the Firebase project settings.
3. Add the service account key JSON to the backend `.env` file as the `SERVICE_ACCOUNT_KEY` environment variable.
### Vercel
1. Create a new project on Vercel and link it to your GitHub repository.
2. Add the `SERVICE_ACCOUNT_KEY` environment variable in the Vercel project settings.
3. Deploy the project.
## Usage
- Open the [live link](https://tasks-vert.vercel.app/) to access the application.
- Add, update, and delete tasks as needed.
## Links
- Live Link: [https://tasks-vert.vercel.app/](https://tasks-vert.vercel.app/)
- Source Code: [https://github.com/iamsjunaid/tasks](https://github.com/iamsjunaid/tasks)
## License
This project is licensed under the MIT License. See the [LICENSE](https://github.com/iamsjunaid/tasks/blob/main/LICENSE) file for details.