-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update copyright notice in LICENSE file and add readme
- Loading branch information
Showing
2 changed files
with
159 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,70 +1,191 @@ | ||
| # Getting Started with Create React App | ||
| <a name="readme-top"></a> | ||
|
|
||
| This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). | ||
| <div align="center"> | ||
| <img src='./public/images/StaySphere.svg" alt="logo" width="140" height="auto" | ||
| <h1><b> StaySphere </b></h1> | ||
|
|
||
| ## Available Scripts | ||
| </div> | ||
|
|
||
| In the project directory, you can run: | ||
| <!-- TABLE OF CONTENTS --> | ||
|
|
||
| ### `npm start` | ||
| # 📗 Table of Contents | ||
|
|
||
| Runs the app in the development mode.\ | ||
| Open [http://localhost:3000](http://localhost:3000) to view it in your browser. | ||
| - [📗 Table of Contents](#-table-of-contents) | ||
| - [📖 StaySphere ](#-staysphere-) | ||
| - [🛠 Built With ](#-built-with-) | ||
| - [Tech Stack ](#tech-stack-) | ||
| - [Key Features ](#key-features-) | ||
| - [🚀 Live Demo ](#-live-demo-) | ||
| - [💻 Getting Started ](#-getting-started-) | ||
| - [Prerequisites](#prerequisites) | ||
| - [Setup](#setup) | ||
| - [Install](#install) | ||
| - [Usage](#usage) | ||
| - [Deployment](#deployment) | ||
| - [👥 Authors ](#-authors-) | ||
| - [🔭 Future Features ](#-future-features-) | ||
| - [🤝 Contributing ](#-contributing-) | ||
| - [⭐️ Show your support ](#️-show-your-support-) | ||
| - [🙏 Acknowledgments ](#-acknowledgments-) | ||
| - [📝 License ](#-license-) | ||
|
|
||
| The page will reload when you make changes.\ | ||
| You may also see any lint errors in the console. | ||
| <!-- PROJECT DESCRIPTION --> | ||
|
|
||
| ### `npm test` | ||
| # 📖 StaySphere <a name="about-project"></a> | ||
|
|
||
| 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. | ||
| **StaySphere** this app built with Rails and React on two different apps. This application enables users to signin/signup create hotels/AirBnb listings and create reservations on each hotel. | ||
|
|
||
| ### `npm run build` | ||
| ## 🛠 Built With <a name="built-with"></a> | ||
|
|
||
| Builds the app for production to the `build` folder.\ | ||
| It correctly bundles React in production mode and optimizes the build for the best performance. | ||
| - **Ruby on Rails** | ||
| - **React and Redux** | ||
|
|
||
| The build is minified and the filenames include the hashes.\ | ||
| Your app is ready to be deployed! | ||
| ### Tech Stack <a name="tech-stack"></a> | ||
|
|
||
| See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. | ||
| - Ruby | ||
| - Rails | ||
| - Postgresql | ||
|
|
||
| ### `npm run eject` | ||
| <!-- Features --> | ||
|
|
||
| **Note: this is a one-way operation. Once you `eject`, you can't go back!** | ||
| ### Key Features <a name="key-features"></a> | ||
|
|
||
| If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. | ||
| - **[React Components]** | ||
| - **[Redux]** | ||
| - **[Database]** | ||
| - **[Rails API]** | ||
|
|
||
| Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own. | ||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it. | ||
| <!-- LIVE DEMO --> | ||
|
|
||
| ## Learn More | ||
| ## 🚀 Live Demo <a name="live-demo"></a> | ||
|
|
||
| You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). | ||
| - Coming soon. | ||
|
|
||
| To learn React, check out the [React documentation](https://reactjs.org/). | ||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| ### Code Splitting | ||
| <!-- GETTING STARTED --> | ||
|
|
||
| This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting) | ||
| ## 💻 Getting Started <a name="getting-started"></a> | ||
|
|
||
| ### Analyzing the Bundle Size | ||
| To get a local copy up and running, follow these steps. | ||
|
|
||
| This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size) | ||
| ### Prerequisites | ||
|
|
||
| ### Making a Progressive Web App | ||
| In order to run this project you need: | ||
|
|
||
| This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app) | ||
| - VScode | ||
| - Ruby | ||
| - Rails | ||
| - Postgres | ||
|
|
||
| ### Advanced Configuration | ||
| ### Setup | ||
|
|
||
| Clone this repository to your desired folder: | ||
|
|
||
| Make sure you setup and run the back-end first. | ||
|
|
||
| ```sh | ||
| git clone git@github.com:tsheporamantso/final-capstone-react-front-end.git | ||
| cd final-capstone-react-front-end | ||
| ``` | ||
|
|
||
| ### Install | ||
|
|
||
| Install this project with: | ||
|
|
||
| ```sh | ||
| npm install | ||
| ``` | ||
|
|
||
| ```sh | ||
| rails db:create | ||
| ``` | ||
|
|
||
| ```sh | ||
| rails db:migrate | ||
| rails db:seed | ||
| ``` | ||
|
|
||
| ### Usage | ||
|
|
||
| To run the project, execute the following command: | ||
|
|
||
| ```sh | ||
| npm start | ||
| ``` | ||
|
|
||
| This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration) | ||
|
|
||
| ### Deployment | ||
|
|
||
| This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment) | ||
| Not deployed | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| <!-- AUTHORS --> | ||
|
|
||
| ## 👥 Authors <a name="authors"></a> | ||
|
|
||
| 👤 **Gladwin Tshepo Ramantso** | ||
|
|
||
| - GitHub: [@tsheporamantso](https://github.com/tsheporamantso) | ||
| - Twitter: [@ramgt001](https://twitter.com/ramgt001) | ||
| - LinkedIn: [Tshepo Gladwin Ramantso](https://www.linkedin.com/in/tshepo-ramantso-b6a35433/) | ||
|
|
||
| 👤 **George Hamman** | ||
|
|
||
| - GitHub: [@githubhandle](https://github.com/George7h) | ||
| - LinkedIn: <a href="https://www.linkedin.com/in/george-hamman-95b98224b/">George Hamman</a> | ||
|
|
||
| 👤 **Evans Kofi Nyamekye** | ||
| - GitHub: [evansnyamekye](https://github.com/evansnyamekye) | ||
| - Twitter: [@nyamekye2131](https://twitter.com/nyamekye2131) | ||
| - LinkedIn: [Evans Kofi Nyamekye](https://www.linkedin.com/in/evans-kofi-nyamekye-1980a4117/) | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| <!-- FUTURE FEATURES --> | ||
|
|
||
| ## 🔭 Future Features <a name="future-features"></a> | ||
|
|
||
| - [ ] **Improve Styling** | ||
| - [ ] **Spesific room selection with each place** | ||
| - [ ] **Check to see if a person can book the hotel if they have rooms available** | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| <!-- CONTRIBUTING --> | ||
|
|
||
| ## 🤝 Contributing <a name="contributing"></a> | ||
|
|
||
| Contributions, issues, and feature requests are welcome! | ||
|
|
||
| Feel free to check the [issues page](https://github.com/tsheporamantso/final-capstone-react-front-end/issues). | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| <!-- SUPPORT --> | ||
|
|
||
| ## ⭐️ Show your support <a name="support"></a> | ||
|
|
||
| If you like this project feel free to leave a star and/or follow me on Github. | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| <!-- ACKNOWLEDGEMENTS --> | ||
|
|
||
| ## 🙏 Acknowledgments <a name="acknowledgements"></a> | ||
|
|
||
| I would like to thank the code reviewers for taking the time to review our project and for Microverse for supplying it. | ||
| Also I would like to thank [Murat Korkmaz](https://www.behance.net/muratk) on Behance for the design inspiration. | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| <!-- LICENSE --> | ||
|
|
||
| ## 📝 License <a name="license"></a> | ||
|
|
||
| ### `npm run build` fails to minify | ||
| This project is [MIT](./LICENSE) licensed. | ||
|
|
||
| This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify) | ||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> |