Docs: Update README with full project documentation

README.md

@@ -1,8 +1,8 @@
 <a name="readme-top"></a>
 
 <div align="center">
-    <img src="src/assets/" alt="" width="130"  height="auto" />
-    <h2><b>Documentation Not Ready</b></h2>
+    <img src="public/tesla-red-logo.png" alt="" width="170"  height="auto" />
+    <h2><b>Tesla | Book a Ride App</b></h2>
 </div>
 
 ---
@@ -33,15 +33,40 @@
 
 <!-- ! PROJECT DESCRIPTION -->
 
-# 📖 [PROJECT-NAME] <a name="about-project"></a>
+# 📖 Tesla | Book a Ride App <a name="about-project"></a>
 
-**[PROJECT-NAME]** ...
+**Tesla | Book a Ride App** is a project developed by Front-end [Arturo Emanuel Guerra Iturres](https://www.linkedin.com/in/arturoemanuelguerraiturres/), [Mahammad Mostafa](https://www.linkedin.com/in/mahammad-mostafa/), and Back-end [Demes Ameneshoa](https://www.linkedin.com/in/demesameneshoa/) and [Fatema Nazari](https://www.linkedin.com/in/fatemanazari/).
+
+> Book your ideal Tesla model effortlessly with our new
+> Tesla vehicle booking app! Enjoy daily rates on our five available models,
+> available in cities worldwide. Experience the best service in the industry.
+
+- **Back-end repository:** [Tesla | Book a Ride App - Back-end](https://github.com/mahammad-mostafa/tesla-booking-back-end).
 
 ---
 
 #### Learning objectives
 
--
+- Apply technical knowledge and skills gained in previous modules in a complex project.
+- Understand pros and cons of different approaches of connecting Ruby on Rails back-end with React front-end.
+- Understand principles of Ruby on Rails and React frameworks.
+- Apply JavaScript best practices and language style guides in code.
+- Apply React best practices and language style guides in code.
+- Learn about and practice giving constructive feedback to teammates.
+- Perform a code reviews for a team member.
+- Use the "Review change"" feature from GitHub.
+- Write clear, professional, and respectful review comments for other team members.
+- Explain "why" a change is requested when giving a code review.
+- Plan a 2+ week project with no interim Microverse-set milestones and submit it on time.
+- Apply knowledge of setting working agreements to set group project teams up for success.
+- Independently implement best practices for group agreements to improve teamwork in larger group project.
+- Demonstrate ability to apply best practices of communication for resolving teamwork challenges.
+- Understand that respect is the foundation of strong relationship-building with teammates.
+- Show up throughout group projects as a reliable and committed team member who communicates and manages your time effectively.
+- Recognize the importance of investing in good working relationships with teammates.
+- Understand principles of strong teamwork (being reliable, committed, and consistent) and how to apply them in group projects.
+- Recognize the value of making equal contributions to group projects to produce the best outcome.
+- Use empty Kanban board to manage tasks with team and own time on the project.
 
 ## 🛠 Built With <a name="built-with"></a>
 
@@ -76,8 +101,15 @@
 
 ### Key Features <a name="key-features"></a>
 
-- **FEATURE 1**
-- **FEATURE 2**
+- Register with name, email, and password.
+- Log in with email and password.
+- View the latest models of Tesla vehicles.
+- Book a ride for a Tesla vehicle.
+- View the details of the vehicle.
+- View the details of the reservation.
+- Add a new vehicle to the database.
+- Delete its own vehicles from the database.
+- Responsive design for all devices.
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
@@ -87,7 +119,7 @@
 
 ## 🚀 Live Demo <a name="live-demo"></a>
 
-- [Live Demo Link]()
+- [Live Demo Link](https://iturres.github.io/tesla-booking-front-end/)
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
@@ -113,21 +145,21 @@ Example commands:
 
 ```bash
   cd my-folder
-  git clone git@github.com:ITurres/
+  git clone git@github.com:ITurres/tesla-booking-front-end.git
 ```
 
 - With HTTPS:
 
 ```bash
   cd my-folder
-  git clone https://github.com/ITurres/
+  git clone https://github.com/ITurres/tesla-booking-front-end.git
 ```
 
 - With GitHub CLI:
 
 ```bash
   cd my-folder
-  gh repo clone ITurres/
+  gh repo clone ITurres/tesla-booking-front-end
 ```
 
 ### Install
@@ -152,14 +184,19 @@ Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
 The page will reload when you make changes.\
 You may also see any lint errors in the console.
 
-### Run tests
+### Run Linters
+
+#### ESLint
 
 ```bash
-  npm test
+  npx eslint "**/*.{js,jsx}"
 ```
 
-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.
+#### Stylelint
+
+```bash
+  npx stylelint "**/*.{css,scss}"
+```
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
@@ -169,6 +206,8 @@ See the section about [running tests](https://facebook.github.io/create-react-ap
 
 ## 👥 Authors <a name="authors"></a>
 
+👤 **Arthur Iturres**
+
 - GitHub: [@ITurres](https://github.com/ITurres)
 - LinkedIn: [Arthur Emanuel G. Iturres](https://www.linkedin.com/in/arturoemanuelguerraiturres/)
 - Angellist / Wellfound: [Arturo (Arthur) Emanuel Guerra Iturres](https://wellfound.com/u/arturo-arthur-emanuel-guerra-iturres)
@@ -189,7 +228,9 @@ See the section about [running tests](https://facebook.github.io/create-react-ap
 
 ## 🔭 Future Features <a name="future-features"></a>
 
-- [ ] **future features 1**
+- [ ] **Test the app with Jest and React Testing Library.**
+- [ ] **Address the inner issues left at the final-touches issue.**
+- [ ] **Dark mode.**
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
@@ -221,7 +262,7 @@ Give a ⭐ if you liked this project!
 
 ## 🙏 Acknowledgments <a name="acknowledgements"></a>
 
-I thank the **Code Reviewers** for their advice and time 🏆
+- We the team would like to thank each other for the hard work and dedication to this project.
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>