Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codewithmike01/applyforme-api-hng
https://github.com/codewithmike01/applyforme-api-hng
Last synced: 18 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/codewithmike01/applyforme-api-hng
- Owner: codewithmike01
- Created: 2022-11-25T21:10:14.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2022-11-25T21:51:06.000Z (almost 2 years ago)
- Last Synced: 2024-10-10T01:25:56.399Z (29 days ago)
- Language: JavaScript
- Size: 8.63 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
Awesome Lists containing this project
README
# ApplyForMe UI
This project provides the user interface and client-side logic to implement a service that helps users apply for jobs without stress.
# How To Contribute
Contribute to ApplyForMe UI in a few steps:
### Clone this repository
Clone this repository to your computer
git clone https://github.com/workshopapps/applyforme.web.git
### Switch to the `ui` branch
git checkout Ui
### Creat a branch
Create a new branch for your work, naming your branch accordingly, following the [recommended naming format](#):
git checkout -b feat/FE-new-feature
### NOTE:
- Do NOT work on or make changes to files while on `main` or `ui` branches or any others you did not create.
- Make your pull requests to the `ui` branch.
- Read the [documentation](./docs/CONTRIBUTING.md) for more information.
## Run in Development Mode
Run this project on your machine by navigating to the folder where you want to locate the project and following the steps below.
1. Clone the repository by running this command in the terminal:
git clone https://github.com/workshopapps/applyforme.web.git
2. Navigate to the project folder:
cd applyforme.web/Apply-For-Me-UI
3. Install the dependencies:
npm install
4. Start the local development server:
npm start
5. Finally, open your browser and visit [http://localhost:3000](http://localhost:3000) to explore the app.
# More Information on Getting Started with Create React App
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
## Available Scripts
In the project directory, you can run:
### `npm start`
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
The page will reload when you make changes.\
You may also see any lint errors in the console.
### `npm test`
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.
### Folder Structure
1. Relevant for the project:
```bash
.
├── docs
├── src
├── assets
├── fonts
├── images
├── components
├── pages
├── App.js
├── README.md
```
## 🤝 Contribute
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/workshopapps/applyforme.web.git/issues)
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
- Zuri HNG
- Hat tip to anyone whose code was used
- Inspiration
## 📝 License
This project is [MIT](./MIT.md) licensed.