Project Name: CurioSights-Frontend
Version: 0.1.0
Description:
This project is the frontend for a MERN stack app to demonstrates use of React, Node, Express and MongoDB. CurioSights is a social media platform where users can share photos of places they have visited and also view the places visited by others.
- Ensure you have Node.js and npm (or Yarn) installed on your machine.
- Clone this repository to your local machine.
- Navigate to the project directory in your terminal.
Run the following command to install the project dependencies:
npm install
or
yarn install
To start the development server, use the following command:
npm start
or
yarn start
The application will be accessible at http://localhost:3000.
To build the application for production, run:
npm run build
or
yarn build
This will create a build folder with optimized production-ready files.
To run the tests for the application, execute:
npm test
or
yarn test
CurioSights-Frontend/
├── node_modules/
├── public/
│ ├── index.html
│ └── ...
├── src/
│ ├── index.js
│ ├── App.js
│ └── ...
├── package.json
├── package-lock.json (or yarn.lock)
├── README.md
└── ...
- React (^16.11.0)
- React DOM (^16.11.0)
- React Router DOM (^6.11.2)
- React Scripts (3.2.0)
- React Transition Group (^4.4.5)
This project uses the react-app configuration for ESLint.
- Production: ">0.2%", "not dead", "not op_mini all"
- Development: "last 1 chrome version", "last 1 firefox version", "last 1 safari version"
Contributions to this project are welcome! Please follow the standard pull request process.
The following links allow to dive deeper into some of the concepts.
-
Official React Docs: https://reactjs.org/docs/getting-started.html
-
Further React Resources: https://academind.com/learn/react/