Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mahammad-mostafa/rank-math-wallet

That is a test project done for Rank Math. It is a simple crypto wallet page built using React & Sass.
https://github.com/mahammad-mostafa/rank-math-wallet

css-flexbox css-modules css3 dark-theme es6-javascript eslint jsx light-theme react react-components reactjs responsive-layout sass state-management stylelint-scss webhint

Last synced: about 1 month ago
JSON representation

That is a test project done for Rank Math. It is a simple crypto wallet page built using React & Sass.

Awesome Lists containing this project

README

        

# 🏷️ Rank Math Wallet

This is a technical test project for **Rank Math** company.


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 displays a simple page for a bitcoin wallet.
Project implemented with `ReactJS` framework.
It applies `Components` and `Hooks`.
Styling inside the project is done with `Sass` & `CSS Modules`.
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.
Linting for `JavaScript` using `Eslint` & for `Sass` using `Stylelint`.

📌 **Live Demo:**
- See the project live from [here](https://rank-math-wallet.onrender.com).

📌 **Tech Stack:**
- Framework used is `ReactJS`
- Page structure is built with `JSX`
- Styling is built with `Sass`
- Dynamic content is built with `ES6 JavaScript`
- Bundling is done with `WebPack`
- Graph chart is built with `Recharts`

📌 **Key Features:**
- Single page app with fixed content
- Responsive layout with all screen sizes
- Simple hover & transition effects
- Static side menu toggling
- Light & dark theme switch

back to top

# 🛠️ Instructions

You can easily download or fork this repository and work on it immadiately!

📌 **Prerequisites:**
- `NodeJS` for installing & running all packages

📌 **Installation:**
- Install all dependencies with `npm`
```
npm install
```

📌 **Development:**
- For live development on `localhost:3000` run:
```
npm run start
```

📌 **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
```

back to top

# 👥 Authors

📌 **Mahammad:**
- [GitHub](https://github.com/mahammad-mostafa)
- [Twitter](https://twitter.com/mahammad_mostfa)
- [LinkedIn](https://linkedin.com/in/mahammad-mostafa)

back to top

# 🔭 Future

Some additional features I may implement in the project:
- [ ] Additional pages like `Home` page
- [ ] Implement advanced `Hooks` features like `useMemo`

back to top

# 🤝🏻 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.

back to top

# ⭐️ Support

Like this project? Show your support by starring!

back to top

# 🙏🏻 Acknowledgements

I thank everyone at **Rank Math** for guiding me through this project.

back to top

# 📝 License

This project is [MIT](LICENSE.md) licensed.

back to top