Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/atharva-narkhede/photography_contest_backend
A backend API for managing photography contests with CRUD operations for users, contests, photos, votes, and admin. Built with Node.js, Express, and MongoDB.
https://github.com/atharva-narkhede/photography_contest_backend
api backend backend-api express mongodb mongodb-atlas nodejs photography photography-website react
Last synced: about 4 hours ago
JSON representation
A backend API for managing photography contests with CRUD operations for users, contests, photos, votes, and admin. Built with Node.js, Express, and MongoDB.
- Host: GitHub
- URL: https://github.com/atharva-narkhede/photography_contest_backend
- Owner: atharva-narkhede
- License: mit
- Created: 2024-06-26T04:16:54.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-08-26T16:54:00.000Z (3 months ago)
- Last Synced: 2024-08-26T19:05:26.073Z (3 months ago)
- Topics: api, backend, backend-api, express, mongodb, mongodb-atlas, nodejs, photography, photography-website, react
- Language: JavaScript
- Homepage:
- Size: 3.69 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Photography Contest Backend API
This project is a backend API for handling CRUD operations in a photography contest application. The API is built using Node.js, Express, and Mongoose for MongoDB.
## Features
- **Create**: Add new users, contests, photos, votes, and admin.
- **Read**: Fetch user, contest, photo, vote, and admin details.
- **Update**: Modify existing user, contest, photo, vote, and admin information.
- **Delete**: Remove users, contests, photos, votes, and admin from the database.
## Prerequisites
Before you begin, ensure you have met the following requirements:
- Node.js (>= 14.0.0)
- MongoDB (>= 4.0)
- Git
- Postman (for testing the API)
## Getting Started
### Cloning the Repository
To get a local copy up and running, follow these simple steps:
1. Clone the repository
```sh
git clone https://github.com/your-username/photography-contest-backend.git
```
2. Navigate to the project directory
```sh
cd photography-contest-backend
```
### Installing Dependencies
Run the following command to install the required dependencies:
```sh
npm install
```
### Setting Up Environment Variables
Create a `.env` file in the root directory and add your MongoDB URI and server port:
```sh
PORT=5000
MONGO_URI=your_mongodb_connection_string
```
### Running the Application
Start the development server with the following command:
```sh
npm run dev
```
The server will start on `http://localhost:5000`.
## Directory Structure
- `models/`: Contains schema definitions for Admin, Contest, Photo, User, and Vote.
- `routes/`: Contains route files for Admin, Contest, Photo, User, and Vote.
- `apis/`: Contains API logic for Admin, Contest, Photo, User, and Vote.
- `utils/`: Contains utility files such as MongoDB connection setup.
## API Endpoints
### Common Endpoints for Admin, Contests, Photos, Users, and Votes
#### Create
- **URL**: `/{entity}/insert`
- **Method**: `POST`
#### Fetch
- **URL**: `/{entity}/fetch`
- **Method**: `GET`
#### Update
- **URL**: `/{entity}/update`
- **Method**: `PUT`
#### Delete
- **URL**: `/{entity}/delete`
- **Method**: `DELETE`
Replace `{entity}` with `admin`, `contest`, `photo`, `user`, or `vote` to perform the respective operations.
## Testing the API with Postman
1. Open Postman and create a new collection.
2. Add requests to the collection for each of the CRUD operations.
3. Set the request method and URL according to the API endpoints described above.
4. Send the requests and verify the responses.
## Contributing
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the MIT License. See `LICENSE` for more information.
## Contact
Your Name - [[email protected]](mailto:[email protected])
Project Link: [https://github.com/your-username/photography-contest-backend](https://github.com/your-username/photography-contest-backend)