Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mahammad-mostafa/react-tutorial
This is the second project of the third module in Microverse program. It is an exercise tutorial created with React framework.
https://github.com/mahammad-mostafa/react-tutorial
css-modules es6-javascript gitflow-workflow jsx microverse microverse-projects microverse-students react react-hooks react-router reactjs single-page-app webpack
Last synced: about 1 month ago
JSON representation
This is the second project of the third module in Microverse program. It is an exercise tutorial created with React framework.
- Host: GitHub
- URL: https://github.com/mahammad-mostafa/react-tutorial
- Owner: mahammad-mostafa
- License: mit
- Created: 2023-08-16T01:23:17.000Z (over 1 year ago)
- Default Branch: development
- Last Pushed: 2023-09-12T18:07:43.000Z (over 1 year ago)
- Last Synced: 2024-10-19T02:46:26.013Z (3 months ago)
- Topics: css-modules, es6-javascript, gitflow-workflow, jsx, microverse, microverse-projects, microverse-students, react, react-hooks, react-router, reactjs, single-page-app, webpack
- Language: JavaScript
- Homepage: https://mahammad-mostafa.github.io/react-tutorial-app/build/
- Size: 3.01 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 🏷️ React Tutorial
This is the second project of the third module in the **Microverse** program.
Check the below contents for further details about this project.
# 📗 Contents
- [Description](#description)
- [Instructions](#instructions)
- [Authors](#authors)
- [Future](#future)
- [Contributions](#contributions)
- [Support](#support)
- [Acknowledgements](#acknowledgements)
- [License](#license)
# 📖 Description
This project is a tutorial exercise for `ReactJS` framework.
It applies `Components` and `Hooks` along with `GitFlow` workflow.
All project dynamic files are contained in `src` directory while static assets are in `public` directory.
The live build is generated inside the `build` directory.
Also config linters for (`CSS3` / `JavaScript`) in the `.github` folder.
📌 **Live Demo:**
- See the project live from [here](https://mahammad-mostafa.github.io/react-tutorial-app/build).
📌 **Tech Stack:**
- Framework used is `ReactJS`
- Page structure is built with `JSX`
- Styling is built with `CSS3`
- Dynamic content is built with `ES6` JavaScript
- Bundling is done with `WebPack`
📌 **Key Features:**
- Single page app with all content loaded dynamically
- Responsive layout with all screen sizes
- Dynamic page navigation without reloading
- Simple Todo list with `CRUD` operations
- Small hamburger menu for browsing
# 🛠️ Instructions
You can easily download or fork this repository and work on it immadiately!
📌 **Prerequisites:**
- `NodeJS` for installing & running all packages
📌 **Setup:**
- Install all dependencies with `npm`
```
npm install
```
- For live development on `localhost:3000` run:
```
npm run start
```
- Unit testing is done with:
```
npm run test
```
📌 **Deployment:**
- You can deploy this project by uploading files in the `build` folder to a live server.
- Create the distribution build using this command:
```
npm run build
```
# 👥 Authors
📌 **Mahammad:**
- [GitHub](https://github.com/mahammad-mostafa)
- [Twitter](https://twitter.com/mahammad_mostfa)
- [LinkedIn](https://linkedin.com/in/mahammad-mostafa)
# 🔭 Future
Some additional features I may implement in the project:
- [ ] Using `CSS` preprocessors and their relevant loaders
- [ ] Implement advanced `Hooks` features like `useMemo`
# 🤝🏻 Contributions
Wish to contribute to this project?
Contributions, issues, and feature requests are more than welcome!
Feel free to check the [issues](../../issues) page too.
# ⭐️ Support
Like this project? Show your support by starring!
# 🙏🏻 Acknowledgements
I thank everyone at **Microverse** for guiding me through this project.
# 📝 License
This project is [MIT](LICENSE.md) licensed.