Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/skabeo/greetings-frontend
This repo is the frontend of a simple webapp that displays random messages
https://github.com/skabeo/greetings-frontend
Last synced: 25 days ago
JSON representation
This repo is the frontend of a simple webapp that displays random messages
- Host: GitHub
- URL: https://github.com/skabeo/greetings-frontend
- Owner: skabeo
- License: mit
- Created: 2023-08-15T08:54:06.000Z (about 1 year ago)
- Default Branch: develop
- Last Pushed: 2023-08-15T12:25:49.000Z (about 1 year ago)
- Last Synced: 2023-08-15T12:36:51.169Z (about 1 year ago)
- Size: 201 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Greeting frontend
- [📗 Table of Contents ](#-table-of-contents-)
- [📖 Greeting frontend Project ](#-catalog-ruby-project-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Backend repo](#back)
- [👥 Author ](#-author-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [❓ FAQ ](#-faq-)
- [📝 License ](#-license-)
**Greetings frontend** repository hosts the web interface for a random message display application. Users can enjoy a variety of messages with each visit, enhancing their browsing experience.
Technology
- [React](https://reactjs.org/) - A frontend framework for building user interfaces
- [Redux](https://redux.js.org/) - A predictable state management library for JavaScript applications.
- [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript) - A high-level programming language used for web development.
- [npm](https://www.npmjs.com/) - A package manager for the Node.js runtime environment
- [Create React App](https://create-react-app.dev/) - A tool used to quickly set up a modern React web application with no build configuration required.
- [HTML](https://developer.mozilla.org/en-US/docs/Web/HTML) - A markup language used for creating web pages
- [CSS](https://developer.mozilla.org/en-US/docs/Web/CSS) - A style sheet language used for describing the presentation of a document written in HTML
Tools
- User can view random messages
### Prerequisites
In order to reproduce the receipe-app and be able to make changes for your own purpose, you need the following tools:
- [Visual Studio Code](https://code.visualstudio.com/)
- [git-scm](https://git-scm.com/)
- A [Github](https://github.com/) account
### Setup
Clone this repository to your desired folder by running the following command:
```sh
git clone https://github.com/skabeo/greetings-frontend.git
```
### Install
To use this application, you need to have `node` installed on your machine. Once you have them installed,
Run bundle install to install all dependencies
```sh
cd greetings-frontend
npm install
```
Once you have the files on your machine, you can view it on your browser on `https://localhost:3000` by running
```
npm start
```
### Backend repository
To access the backend scripts that power this user interface, please refer to the instructions in the README of the backend repository linked [here](https://github.com/skabeo/rails-api/pull/1).
👤 **Spencer Okyere**
- GitHub: [@skabeo](https://github.com/skabeo)
- Twitter: [@black_okyere](https://twitter.com/black_okyere)
- LinkedIn: [LinkedIn](https://linkedin.com/in/spencer-okyere)
- Improved user interface
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/skabeo/greetings-frontend/issues).
If you would like to contribute to this project, you can follow these steps:
1. Fork the repository.
2. Create a new branch for your changes.
3. Make your changes and commit them.
4. Push your changes to your forked repository.
5. Create a pull request back to the original repository.
If you like this project, please give it a star on GitHub.
I would like to express my gratitude to the following individuals and organizations for their contributions to this project:
- [GitHub](https://github.com/): Platform for version control and collaboration
- [Microverse](https://www.microverse.org/): Global school for remote software developers
- **How can I contribute to this project?**
- Contributions, issues, and feature requests are welcome! You can check the issues page to see if there are any current issues or feature requests that you can work on. If not, feel free to submit a new issue or pull request. Before contributing, please read the CONTRIBUTING.md file for guidelines on how to contribute to this project.
This project is [MIT](https://github.com/skabeo/greetings-frontend/blob/develop/LICENSE) licensed.