RentNStudy¶

GitHub Build Coverage Docs

RentNStudy is a College Housing Rental Site that would exclusively allow college affiliates (student and faculty) to look for housing easily and reliably all year long.

Usage¶

Able to search for housing by type, price, and size.
Able to be view relevant details and information on specific housing apartments.

To use RentNStudy, create a copy of the project. In the project directory, you can run:

npm start¶

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

npm run build¶

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

Documentation¶

Documentation is hosted through ReadTheDocs here.

Created using Sphinx.

Contributing¶

Coming Soon.

See CONTRIBUTING.md for more.

License¶

Distributed under the Apache-2.0 license. See LICENSE for more.

Acknowledgements¶

RentNStudy uses a variety of technologies for this project. It uses React Router for routing, React Context API for state management, and Contentful Headless CMS for Data Management.