MERN
A Simple MERN App.
THIS REPOSITORY IS JUST FOR TRAINING PURPOSE
Contribution
Feel free to fork and contribute to this repository. Also be free to star this repository.
Technologies & Methodologies:
- NodeJS
- Express
- MongoDB
- React
- TypeScript
- Mocha
- Chai
User Manual
Welcome to the user manual for building, testing and running your app using the following commands:
-
npm run build
: This command is used to build the static files of your application. To execute this command, open your terminal, navigate to your project directory, and typenpm run build
. This will generate a build folder with your application’s static files. -
npm run test
: This command is used to run your application’s tests. Before running tests, make sure that you have installed all the required dependencies for testing. To execute this command, open your terminal, navigate to your project directory, and typenpm run test
. This will run all the tests in your application and provide you with the results. -
npm run start
: This command is used to start your application. Before running your application, make sure that you have installed all the required dependencies for running your application. To execute this command, open your terminal, navigate to your project directory, and typenpm run start
. This will start your application and you can access it on your web browser by visiting http://localhost:5000 (port can be different depending on environment). -
npm run dev
: This command is used to start your application in development mode. Before running your application in development mode, make sure that you have installed all the required dependencies for running your application. To execute this command, open your terminal, navigate to your project directory, and typenpm run dev
. This will start your application in development mode and you can access it on your web browser by visiting http://localhost:5000 (port can be different depending on environment). In development mode, your application will automatically rebuild and refresh the page as you make changes to your code, which is useful for rapid development and testing. -
npm run lint
: This command is used to check your code for any syntax or style errors using eslint. Before running this command, make sure that you have installed all the required dependencies for linting. To execute this command, open your terminal, navigate to your project directory, and typenpm run lint
. This will check your files for errors and report any errors or warnings found.
Note:
If you encounter any issues while building, testing, or running your application, make sure that you have installed all the required dependencies for your project. You can check the required dependencies in your package.json file.
Additionally, make sure that you have followed the correct file structure and naming conventions for your project as per the standards.
Congratulations! You are now equipped with the necessary knowledge to build, test, and run your application using the given commands. Good luck!