Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fmanimashaun/edustipend-submit
This project is an assessment for the position of FFront-end Engineer (React) Volunteer at Edustipend. The purpose of this project is to test my skills and knowledge in ReactJS, HTML, CSS, and JavaScript.
https://github.com/fmanimashaun/edustipend-submit
bootstrap5 gh-pages prop-types react-bootstrap react-icons reactjs sass
Last synced: 14 days ago
JSON representation
This project is an assessment for the position of FFront-end Engineer (React) Volunteer at Edustipend. The purpose of this project is to test my skills and knowledge in ReactJS, HTML, CSS, and JavaScript.
- Host: GitHub
- URL: https://github.com/fmanimashaun/edustipend-submit
- Owner: fmanimashaun
- License: mit
- Created: 2023-05-16T11:43:34.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-05-22T11:17:05.000Z (over 1 year ago)
- Last Synced: 2024-10-09T07:41:30.065Z (about 1 month ago)
- Topics: bootstrap5, gh-pages, prop-types, react-bootstrap, react-icons, reactjs, sass
- Language: SCSS
- Homepage: https://fmanimashaun.github.io/edustipend-submit/
- Size: 1.22 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [Mockup](#mockup)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [📷 Screenshot](#screenshot)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
# 📖 Edustipend Front-End Engineer Assessment
This project is an assessment for the position of FFront-end Engineer (React) Volunteer at Edustipend. The purpose of this project is to test my skills and knowledge in ReactJS, HTML, CSS, and JavaScript.
The project is divided into two parts:
- Identification of core components
- Writing React code for two of the components
Based on the given mockup, the following can be identified as the core components of the project:
- Header component: contains the contact us link and signup button component.
- Hero component: Here, we have a heading text, a subtext and a button component.
- Aside card component: Here, we have a heading text, list item components showing trending songs and icons and a "see more" button component.
- [React](https://reactjs.org/)
- [React Bootstrap](https://react-bootstrap.github.io/)
- [Bootstrap](https://getbootstrap.com/)
- [React Icons](https://react-icons.github.io/react-icons/)
- [PropTypes](https://www.npmjs.com/package/prop-types)
- [Sass](https://sass-lang.com/)
- [x] The use of React Bootstrap to provide a responsive and customizable user interface.
- [x] The use of Bootstrap to provide a library of pre-styled components.
- [x] The use of React Icons to provide a library of React components for displaying icons.
- [x] The use of PropTypes to provide type safety for React components.
- [x] The use of Sass to provide a powerful CSS preprocessor.
- [Live Demo Link](https://fmanimashaun.github.io/edustipend-submit/)
- [Optional] Install git bash to your machine to enable you to clone this repo.
- install Visual Studio to be able to host a local live version.
- Install a browser to view the local live version.
To get a local copy up and running follow these simple example steps.
### Setup
Clone this repository to your desired folder:
```sh
cd your-desired-folder
git clone https://github.com/fmanimashaun/edustipend-submit.git
open the repo folder `edustipend-submit`
```
Install this project dependencies with:
```sh
npm install
```
To run the project, execute the following command:
```sh
npm run start
```
Runs the app in the development mode.\
Open [http://localhost:3000/edustipend-submit](http://localhost:3000/edustipend-submit) to view it in your browser.
The page will reload when you make changes.\
You may also see any lint errors in the console.
To run tests to check the lint errors, run the following command:
- To check for CSS lint errors, run the following command:
```sh
npm run stylelint
```
- To check for JS lint errors, run the following command:
```sh
npm run eslinter
```
Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
You can deploy this project to github pages by running the following command:
```sh
npm run deploy
```
Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.\
and it is automatically deployed to the github page.
See the section about [github page deployment](https://github.com/gitname/react-gh-pages) for more information.
👤 **Engr. Animashaun Fisayo**
- [GitHub](https://github.com/fmanimashaun)
- [Twitter](https://twitter.com/fmanimashaun)
- [LinkedIn](https://www.linkedin.com/in/fmanimashaun/)
- [Website](https://fmanimashaun.com)
-[ ] Add api to fetch data for the aside card component.
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project and want to support me, you can give a ⭐️ to this repo!
I would like to thank [Edustipend](https://www.edustipend.org/) for giving me this opportunity to take part in the pre-assessment test.
> None for now
This project is [MIT](./LICENSE) licensed.