📗 Table of Contents

• 📖 About the Project
  • Mockup
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 📷 Screenshot
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 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

Mockup

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.

(back to top)

🛠 Built With

Tech Stack

• React
• React Bootstrap
• Bootstrap
• React Icons
• PropTypes
• Sass

Key Features

• The use of React Bootstrap to provide a responsive and customizable user interface.
• The use of Bootstrap to provide a library of pre-styled components.
• The use of React Icons to provide a library of React components for displaying icons.
• The use of PropTypes to provide type safety for React components.
• The use of Sass to provide a powerful CSS preprocessor.

(back to top)

🚀 Live Demo

• Live Demo Link

📷 Screenshot

(back to top)

💻 Getting Started

Prerequisites

• [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:

  cd your-desired-folder
  git clone https://github.com/fmanimashaun/edustipend-submit.git
  open the repo folder `edustipend-submit`

Install

Install this project dependencies with:

  npm install

Usage

To run the project, execute the following command:

  npm run start

Runs the app in the development mode.
Open 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.

Run tests

To run tests to check the lint errors, run the following command:

• To check for CSS lint errors, run the following command:

  npm run stylelint

• To check for JS lint errors, run the following command:

  npm run eslinter

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

Deployment

You can deploy this project to github pages by running the following command:

  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 for more information.

(back to top)

👥 Authors

👤 Engr. Animashaun Fisayo

• GitHub
• Twitter
• LinkedIn
• Website

(back to top)

🔭 Future Features

-[ ] Add api to fetch data for the aside card component.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project and want to support me, you can give a ⭐️ to this repo!

(back to top)

🙏 Acknowledgments

I would like to thank Edustipend for giving me this opportunity to take part in the pre-assessment test.

(back to top)

❓ FAQ (OPTIONAL)

None for now

(back to top)

📝 License

This project is MIT licensed.

(back to top)