https://github.com/aayushker/foody
A recipe sharing website
https://github.com/aayushker/foody
django-rest-framework jwt-authentication nextjs nextui postgresql
Last synced: 8 months ago
JSON representation
A recipe sharing website
- Host: GitHub
- URL: https://github.com/aayushker/foody
- Owner: aayushker
- Created: 2024-06-20T14:52:53.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-01T16:34:33.000Z (about 1 year ago)
- Last Synced: 2025-04-01T17:46:33.911Z (about 1 year ago)
- Topics: django-rest-framework, jwt-authentication, nextjs, nextui, postgresql
- Language: TypeScript
- Homepage: https://letsfoody.vercel.app
- Size: 3.12 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Security: SECURITY.md
Awesome Lists containing this project
README
*(under development)*
[]()
[](https://letsfoody.vercel.app)
Welcome to Foody, your go-to recipe website where you can explore, cook, and share your favorite dishes. This README provides detailed instructions on setting up, using, and understanding the features and technologies behind the Foody project.
The project is built using the Django REST Framework for the backend API and Next.js for the frontend application. The application allows users to register, login, and manage recipes, with an admin panel for site management.
## Table of Contents
- [Features](#features)
- [Technologies Used](#technologies-used)
- [Installation](#installation)
- [Usage](#usage)
- [Project Structure](#project-structure)
- [API Endpoints](#api-endpoints)
- [Contributing](#contributing)
- [License](#license)
## Features
- **User Authentication:** Secure login and registration using JWT tokens.
- **Dashboard:** Personalized user dashboard to manage profiles and recipes.
- **Recipe Management:** Add, edit and delete recipes with detailed information.
- **Responsive Design:** Optimized for both desktop and mobile devices.
- **Dark Mode:** Toggle between light and dark themes.
- **SMTP Integration:** Send emails to users for notifications and updates.
- **Admin Panel:** Manage users, recipes, and other site content from the admin dashboard.
- **Deployment:** Dockerized application for easy deployment and scaling.
## Technologies Used
- **Frontend:**
- Next.js
- NextUI
- TypeScript
- Tailwind CSS
- Framer Motion
- Tabler Icons
- Jodit Editor
- Axios
- JWT-decode
- **Backend:**
- Django
- Django REST Framework
- Simple JWT
- Django CORS Headers
- Pipenv
- Render
- **Database**
- PostgreSQL
- Aiven
- Firebase
- **DevOps:**
- Docker
- Docker Compose
## Installation
### Prerequisites
- Node.js
- npm
- Python
- Docker
### Backend Setup
1. **Clone the repository:**
```bash
git clone https://github.com/aayushker/Foody
cd Foody/backend
2. **Create a virtual environment:**
```bash
python -m venv venv
source venv/bin/activate
3. **Install dependencies:**
```bash
pip install -r requirements.txt
4. **Run the development server:**
```bash
python manage.py runserver
### Frontend Setup
1. **Navigate to the frontend directory:**
```bash
cd ../frontend
2. **Install dependencies:**
```bash
npm install
3. **Run the development server:**
```bash
npm run dev
### Docker Setup
1. **Build and run the Docker containers:**
```bash
docker-compose up --build
## Usage
1. **Running the application:**
- Open your browser and go to `http://localhost:3000` to access the frontend.
- The backend API is available at `http://localhost:8000/api`.
2. **User Authentication:**
- Register a new account or login with your account:
3. **Managing Recipes:**
- Add, edit, or delete recipes from the dashboard.
- Explore recipes from the homepage and view detailed information.
## Project Structure
The project is divided into two main directories: `frontend` and `backend`. The frontend directory contains the Next.js application, while the backend directory contains the Django REST API.
Foody
├── backend
│ ├── backend/
│ ├── recipes/
│ ├── userAuth/
│ ├── SMTP/
│ ├── media/
│ ├── Dockerfile
│ ├── manage.py
│ ├── Pipfile
│ ├── requirements.txt
├── frontend
│ ├── app/
│ │ ├── components/
│ │ │ ├── AddRecipe/
│ │ │ │ ├── sections/
│ │ │ │ └── ui/
│ │ │ ├── context/
│ │ │ ├── ui
│ │ │ │ ├── auth/
│ │ │ ├── UserPanel/
│ │ │ │ ├── sections/
│ │ │ │ ├── ui/
│ │ ├── layout.tsx
│ ├── package.json
│ ├── pages
│ │ ├── addRecipe/ index.tsx
│ │ ├── explore/ index.tsx
│ │ ├── user/ index.tsx
│ │ └── index.tsx
└── README.md
## API Endpoints
1. **Authentication:**
- Register: `POST /api/register/`
- Login: `POST /api/token/`
2. **Recipes:**
- List Recipes: `GET /api/recipes/`
- Create Recipe: `POST /api/addRecipe/`
- Retrieve Recipe: `GET /api/user/recipe/:id/`
- Update Recipe: `PUT /api/user/recipe/:id/`
- Delete Recipe: `DELETE /api/user/recipe/:id/`
3. **Users:**
- User Details: `GET /api/user/`
- User Profile: `GET /api/user/profile/`
- Update Profile: `PUT /api/users/profile/`
- Update Credentials: `PUT /api/user/credentials/`
- Refresh Token: `POST /api/token/refresh/`
4. **SMTP:**
- Send Email: `POST /api/smtp/`
5. **Admin:**
- Admin Panel: `/admin/`
## Contributing
This is a private project for learning purposes, and contributions are not accepted at this time. Suggestions and feedback are always welcome!
## License
This project is licensed under the [GNU GENERAL PUBLIC LICENSE](LICENSE).
Happy cooking with Foody! If you have any questions, feel free to reach me at singhaayushker@gmail.com.