Resume builder web application(MERN).
- Project Description
- Features
- Usage
- Installation
- Environment Variables
- Dependencies
- Contributing
- License
- Contact
Provide a detailed description of your project. Explain what it does, its purpose, and any relevant background information. Mention the technologies or frameworks used.
List the key features and functionalities of your project. Highlight the aspects that make your project unique or useful.
Explain how to use your project. Provide examples, code snippets, or screenshots to demonstrate its usage. Describe any configuration options or important considerations.
- Clone the repository
npm install
on frontend and backend foldernpm run dev
on the root directory : This command will concurrently start both the frontend and backend servers
This project uses environment variables for configuration. Before running the project, make sure to set up the .env
file with the required variables.
- Create a new file named
.env
in the root directory of the project. - Open the
.env
file and add the following variables:
The following environment variables are required in the .env
file:
MONGODB_URI
: The URI for connecting to the project's MongoDB database. This variable should contain the MongoDB connection string, including necessary credentials and other connection details.SECRET_KEY
: The secret key used for JWT token generation and verification. This key is important for securing your JWT tokens and should be kept confidential.PORT
: The port number on which the project will run.
Make sure to replace these variable names with the actual environment variables used in your project.
- react-bootstrap
- bootstrap
- axios
- react-router-dom
- @reduxjs/toolkit
- react-redux
If you encounter any issues related to frontend dependencies, you can try the following steps to resolve them:
- Delete the
node_modules
folder andpackage-lock.json
file. - Run the command
npm cache clean --force
. - Install the
@svgr/webpack
package as a dev dependency by running the commandnpm install @svgr/webpack --save-dev
. - Run the command
npm install
. - If you face any
use of deprecated webpack DevServer onBeforeSetupMiddleware and onAfterSetupMiddleware options
you can refer to this GitHub Pull Request for a potential fix.
- express
- mongoose
- nodemon
- concurrently
- dotenv
- bcrypt
If you'd like to contribute to the project, please follow these guidelines:
- Fork the repository.
- Create a new branch for your feature/fix: git checkout -b feature/your-feature.
- Commit your changes: git commit -m "Add your feature".
- Push to the branch: git push origin feature/your-feature.
- Open a pull request.
This project is licensed under the MIT License. See the LICENSE file for details.
- Email: [email protected]
- Whatsapp: +65 93374545