https://github.com/ahzia/code-buddy-frontend
https://github.com/ahzia/code-buddy-frontend
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ahzia/code-buddy-frontend
- Owner: ahzia
- License: mit
- Created: 2022-01-20T14:53:15.000Z (over 3 years ago)
- Default Branch: develop
- Last Pushed: 2022-02-09T20:44:31.000Z (over 3 years ago)
- Last Synced: 2025-02-03T11:18:23.445Z (4 months ago)
- Language: JavaScript
- Size: 1.99 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CODE BUDDY FRONTEND
> This is a react app which will serve as the front end app for Code Buddy Platfrom, the project is still under development, but some of the functionalites are finalized in the backend & front end, Which you can check it out.
# Demo Link
Click [here](https://ahzia.github.io/code-buddy-frontend/) to see live demo.
## The learning objective of this project are
- Create react front end app
- Connect react front end app to rails back end
- Use API end point to get data
- Fetch data from the API
## Built With
- React
- Redux
- Materia UI
## Getting Started
To get a local copy up and running follow these simple example steps.
### Prerequisites
- [React](https://reactjs.org/tutorial/tutorial.html#prerequisites)
### Setup
- ```git clone [email protected]:ahzia/code-buddy-frontend.git```
- ```cd code-buddy-frontend```
### Running The App Locally
- Run `npm install`
- Make sure to run our [Rails backend application](https://github.com/medaminedev66/lunar-hotel-backend) first before running the React app so that it takes up the `port 3000`. This is very important as our rails API end point must run on `port 3000` for the API to work.
- Once the back end is runing on `port 3000` then start the react app and you will be prompted to run the server on another port like `port 3001`. You will receive a message in your terminal like this `Would you like to run the app on another port instead? » (Y/n)`. Please enter `y` so that the react app will start on `port 3001`.
## Authors
👤 Donard Golaj
Github : [@Donard97](https://github.com/Donard97)
Twitter: [@donardgolaj](https://twitter.com/donardgolaj)
LinkdIn : [@donard-golaj](https://www.linkedin.com/in/donard-golaj/)
👤 Ahmad Zia Yousufi
Github : [@ahzia](https://github.com/ahzia)
Twitter: [@ZiaYousofi](https://twitter.com/ZiaYousofi)
LinkedIn : [@ah-ziayosfi](https://www.linkedin.com/in/ah-ziayosfi/)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/ahzia/code-buddy-frontend/issues).
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
- Hats off to [Murat Korkmaz](https://www.behance.net/muratk) for designing the awesome template that was used. ✨
- Microverse for giving us this chance
- The amazing code reviewers for making us improve every day 👍