https://github.com/sjproctor/learn-apartment-app-react
Instructional project: React application to pair with a Rails API
https://github.com/sjproctor/learn-apartment-app-react
jwt react react-router reactstrap
Last synced: 2 months ago
JSON representation
Instructional project: React application to pair with a Rails API
- Host: GitHub
- URL: https://github.com/sjproctor/learn-apartment-app-react
- Owner: sjproctor
- Created: 2024-04-08T17:44:31.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-19T18:36:05.000Z (about 2 years ago)
- Last Synced: 2025-02-23T00:45:27.926Z (over 1 year ago)
- Topics: jwt, react, react-router, reactstrap
- Language: JavaScript
- Homepage:
- Size: 1.99 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Apartment Application
April 2024
This is an instructional project for LEARN Academy, a web development bootcamp. The purpose of this application is to allow students to make a decoupled full-stack application with user authentication and authorization. The frontend is a React app that makes requests to a separate Rails API using JWT for authentication. The Rails API uses Devise for authentication and authorization.
### 🏡 Apartment App Project Description
Apartment App is a decoupled, full-stack application in React with a Ruby on Rails API that lists apartments available for rent. A visiting user of the application can see a list and of all available apartments. A visiting user can select one apartment and see more details. To list an apartment for rent, a user can create an account and log into the application. A logged in user can add a new apartment and see a list of all their apartments with the ability to edit or delete their own listings.
### ⚡️ Getting Started
First clone the repository. Then within the root of the project directory, run:
```bash
yarn
```
### 🏁 Start the App
```bash
yarn start
```
### 🤝 Application Dependencies
- [React Router DOM](https://reactrouter.com/en/main)
- [Reactstrap](https://deploy-preview-2356--reactstrap.netlify.app/)
- [React Icons](https://react-icons-v2.vercel.app/)
- [React Form](https://react-hook-form.com/get-started)
### 💄 Styling Notations
- light blue: `#00bfea`
- tan: `#DFCBB2`
- olive: `#696049`
- black: `#333333`
### 🚗 Testing
To run the existing React Testing Library testing suite, run:
```bash
yarn test
```