Hewlbern / sitemap

Next.js and FastAPI Project

This project is a web application built with a Next.js frontend and a FastAPI backend. The frontend allows users to create, read, update, and delete issues. The backend serves as an API server that handles these operations.

Table of Contents

• Technologies Used
• Getting Started
• Frontend Setup (Next.js)
• Backend Setup (FastAPI)
• Running the Project
• API Endpoints
• License

Technologies Used

• Next.js
• React
• FastAPI
• Python

Getting Started

Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

• Node.js and npm
• Python and pip

Frontend Setup (Next.js)

1. Clone the repository:

   git clone https://github.com/your-username/your-repo.git
   cd your-repo

2. Navigate to the frontend directory:

   cd frontend

3. Install dependencies:

   npm install

4. Create a .env.local file in the frontend directory and add your environment variables if necessary:

   NEXT_PUBLIC_API_URL=http://localhost:8000
   

5. Run the development server:

   npm run dev

   The frontend should now be running on http://localhost:3000.

Backend Setup (FastAPI)

1. Navigate to the backend directory:

   cd be

2. Create and activate a virtual environment:

   poetry run uvicorn main:app --reload
   
   
   The backend should now be running on [http://localhost:8000](http://localhost:8000).
   

Running the Project

To run the entire project, ensure both the frontend and backend servers are running:

1. Start the Next.js frontend:

   cd frontend
   npm run dev

   Now you can access the application at http://localhost:3000, and it will communicate with the FastAPI backend at http://localhost:8000.

API Endpoints

The FastAPI server exposes the following endpoints:

• POST /issues/: Create a new issue.
• GET /issues/: Retrieve all issues.
• GET /issues/{issue_id}: Retrieve a specific issue by ID.
• PUT /issues/{issue_id}: Update a specific issue by ID.
• DELETE /issues/{issue_id}: Delete a specific issue by ID.

Example curl Commands

1. Create Issue:

   curl -X POST http://localhost:8000/issues/ \
   -H "Content-Type: application/json" \
   -d '{"title": "New Issue", "description": "Description of the new issue"}'
   
   

2. Read All Issues:

curl -X GET http://localhost:8000/issues/

3.	Read Specific Issue:

curl -X GET http://localhost:8000/issues/1

4.	Update Issue:



curl -X PUT http://localhost:8000/issues/1 \

-H "Content-Type: application/json"
-d '{"title": "Updated Issue Title", "description": "Updated description of the issue"}'

5.	Delete Issue:

curl -X DELETE http://localhost:8000/issues/1

License

This project is licensed under the MIT License - see the LICENSE file for details.