This is the backend repository for the Memeet repository.
- Clone the repository:
git clone https://github.com/AlejandroLuisHC/memeet-backend.git
- Install the dependencies:
npm install
- Create a
.env
file in the root of the project and set the environment following the stucture provided in the.env.example
- Start the development server:
npm run dev
- Open the browser and navigate to your localhost port to access the API.
You need to install nodejs
Go to NodeJS web page download and install the program.
- GET
/
: Retrieves a list of all users. - GET
/:id
: Retrieves a specific user by theirid
. - POST
/
: Creates a new user. - DELETE
/:id
: Deletes a specific user by theirid
. - PATCH
/:id
: Updates a specific user by theirid
.
- GET
/
: Retrieves a list of all memes. - GET
/:id
: Retrieves a specific meme by theirid
. - POST
/
: Creates a new meme. - DELETE
/:id
: Deletes a specific meme by theirid
. - PATCH
/:id
: Updates a specific meme by theirid
.
- GET
/
: Retrieves a list of all tags available. - POST
/
: Creates a new tag.
- Express.js: A web application framework for Node.js
- Mongoose: A MongoDB object modeling tool for Node.js
- Cors: A middleware for handling CORS (Cross-Origin Resource Sharing)
- Helmet: A collection of middlewares for security-related HTTP headers
- Morgan: A middleware for logging HTTP requests
- Nodemon: A utility that automatically restarts the Node.js application when changes are detected
- Express-jwt: A middleware for validating JWTs (JSON Web Tokens)
- Jwks-rsa: A library for retrieving RSA signing keys from a JWKS (JSON Web Key Set) endpoint
- Auth0: An authentication and authorization platform for web and mobile apps
- AWS S3 Bucket: An object storage service that provides scalable and secure storage for unstructured data.
I welcome any contributions to Memeet (Backend API). To contribute, please follow these steps:
- Fork the repository by clicking the "Fork" button in the top right corner of this page.
- Clone the forked repository to your local machine by running
git clone https://github.com/[your-name]/memeet-backend.git
in your terminal. - Create a new branch for your contribution by running
git checkout -b [branch-name]
. - Make your changes and test them thoroughly.
- Commit your changes by running
git commit -m "[commit message]"
. - Push your changes to your forked repository by running
git push origin [branch-name]
. - Create a new pull request by navigating to your forked repository on GitHub, selecting the branch you just pushed, and clicking the "New pull request" button.
- Provide a clear and detailed description of your changes and why they are necessary.
- We will review your pull request and provide feedback. Once it is approved, your changes will be merged.
Thank you for your contributions! 🎉