Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/abdullahhussein1/soft-steps-todo-app
A complete Todo App Build with React, TypeScript, Supabase, Express, Shadcn, Authentication.
https://github.com/abdullahhussein1/soft-steps-todo-app
expressjs full-stack postgresql reactjs shadcn-ui supabase tailwindcss todo-app typescript webapp
Last synced: 11 days ago
JSON representation
A complete Todo App Build with React, TypeScript, Supabase, Express, Shadcn, Authentication.
- Host: GitHub
- URL: https://github.com/abdullahhussein1/soft-steps-todo-app
- Owner: abdullahhussein1
- License: mit
- Created: 2023-11-25T13:33:28.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-03T14:51:48.000Z (about 1 month ago)
- Last Synced: 2024-12-03T15:43:15.077Z (about 1 month ago)
- Topics: expressjs, full-stack, postgresql, reactjs, shadcn-ui, supabase, tailwindcss, todo-app, typescript, webapp
- Language: TypeScript
- Homepage: https://softsteps.netlify.app
- Size: 24.2 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Soft Steps - Your Tranquil Todo App
Welcome to **Soft Steps**, your serene companion in achieving productivity effortlessly. This intuitive to-do app is designed to guide you through tasks with simplicity and elegance.
## Preview
---
## Server
### Installation:
1. **Clone the repository:**
```bash
git clone
cd server
```
2. **Install dependencies:**
```bash
npm install
```
3. **Set up environment variables:**
- Rename the `.env.example` file to `.env`:
```bash
mv .env.example .env
```
- Open the `.env` file and replace the placeholders with your Supabase credentials:
```env
SUPABASE_URL=https://.supabase.co
SUPABASE_KEY=
PORT=3000
```
4. **Start the server:**
```bash
npm run start:dev
```
This command compiles TypeScript, starts the server using Nodemon for development, and listens for file changes.
---
## Client
### Installation:
1. **Navigate to the client directory:**
```bash
cd client
```
2. **Install dependencies:**
```bash
npm install
```
3. **Set up environment variables:**
- Rename the `.env.example` file to `.env`:
```bash
mv .env.example .env
```
- Open the `.env` file and replace the placeholders with your environment variables:
```env
VITE_SUPABASE_URL=https://.supabase.co
VITE_SUPABASE_KEY=
VITE_API_BASE_URL=http://localhost:3000
```
4. **Start the client:**
```bash
npm run dev
```
This command launches the Vite development server.
5. **Access the app:**
- Open your browser and go to [http://localhost:5173](http://localhost:5173).
---
## Additional Notes:
- **Important**: If you're using the local server, ensure the server is started **before** running the client. The client-side application relies on the server for API communication.
- Ensure no trailing slashes (`/`) are added to the `.env` variable values.
- The server defaults to port `3000`, but this can be adjusted in the `.env` file.
- Supabase credentials are required for authentication and database access.
---
## Contributing
Thank you for considering contributing to **Soft Steps**!
### Prerequisites:
- Activate GitHub and Google authentication in your Supabase project before contributing.
### How to Contribute:
1. Fork the repository and clone it locally.
2. Create a new branch for your feature or bug fix.
3. Implement your changes, ensuring code quality and clarity.
4. Commit your changes with meaningful commit messages.
5. Push your branch to your forked repository.
6. Submit a pull request to the `main` branch of the original repository.
---
## License
This project is licensed under the [MIT License](LICENSE).