HFG43 / final_capstone_front_end

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool


Final Capstone Front-End | Gourmet Experience App

πŸ“— Table of Contents

Final Capstone Front-End | Gourmet Experience App

This project consists of a web application built with ReactJS and Redux Toolkit that allows users to book gourmet experiences that they can give to others, in a quick and easy way.

This application connects to the GourmetExperience API and obtains all the information of registered users, the list of available gastronomic experiences, the list of reservations made by a selected user, and allows new users to be registered, authenticate existing users, create new reservations and delete them. Likewise, the app is completely responsive and has been built following the best practices of software development. It has robust validations, efficient data management, and a set of unit and integration tests that allowed validating the operation of the entire application.

Kanban Board

Current Statuss

Previous Status

  • We are a Group of 4 Members

πŸ›  Built With

Tech Stack

Client

Live Demo

Live Demo Link

(back to top)

Key Features

  • Using the ReactJS library
  • Using the ReactJS Router library
  • Using JSX syntax
  • Using semantic HTML
  • SPA Approach
  • Responsive Design
  • Using Redux Toolkit for a global state management

(back to top)

πŸš€ Back-End Project

The backend project can be found in the following link: Final Capstone Back-End

(back to top)

πŸ’» Getting Started

To get a local copy up and running, follow these steps.

Setup

Clone this repository to your desired folder:

  cd my-folder-name
  git clone https://github.com/HFG43/final_capstone_front_end.git

Prerequisites

In order to install, modify and run this project, it is necessary to have the following applications installed:

It is also important to have at least basic knowledge about ReactJS, JSX, HTML, CSS and Javascript languages so you will be able to understand and work with the code of the project.

Install

Install this project by running the next command into your project folder:

  npm install

All the packages and libraries necessary for the project to work will be installed in a folder called /node_module. After finishing the installation of this project, you should verify that you have the Final Capstone Back-End installed so that this project can work as expected.

Usage

IMPORTANT NOTE: As specified above, to run this project you must have the Final Capstone Back-End project installed and running, since it contains the API that will be consuming in this project. Please do not run this project without first running the project mentioned previously.

In the project directory, you can run:

  • npm start

A message similar to this will be displayed in the console: Alt text

When the above message appears, press the Y key to allow the server to run the application on another available port (usually port 3001).

When everything is ready, this message should appear in the console:

  • compiled successfully!

Open the main URL: http://localhost:3001 to see the app running in your browser.

The page will reload when you make changes.

You may also see any CSS and JS linters errors in the console running the following commands:

CSS Linter

  npx stylelint "**/*.{css,scss}"

Javascript Linter

  npx eslint "**/*.{js,jsx}"

Testing

Run the following command to verify the quality of the application code through the designed test cases:

  npm test

Build

  • 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.

The build is minified and the filenames include the hashes.\

Your app is ready to be deployed!

Note: Please only modify the components files and the CSS files. Do not modify configurations files of the project.

πŸ‘₯ Authors

πŸ‘€ AndrΓ©s Zamorano

πŸ‘€ Andrea Manuel

πŸ‘€ Nitcelis Bravo

πŸ‘€ HernΓ‘n GΓΌemes

(back to top)

πŸ”­ Future Features

  • Add user roles and administrator account
  • Add functionality to Create Experiences by the user admin
  • Add the functionality to Update reservations: Components, UI, Actions
  • Add custom animations using libraries such as Animate.css and Framer Motion
  • Add functionality to have a dark and light design

(back to top)

🀝 Contributing

Contributions, issues, suggestions and feature requests are welcome! Feel free to check the issues page.

To do Contributions, please fork this repository, create a new branch and then create a Pull Request from your branch. You can find detailed description of this process in: A Step by Step Guide to Making Your First GitHub Contribution by Brandon Morelli

(back to top)

⭐️ Show your support

If you liked this project, give me a "Star" (clicking the star button at the beginning of this page), share this repo with your developer community or make your contributions.

(back to top)

πŸ™ Acknowledgments

The UI design of this webapp is not ours. This design was created and belongs to Murat Korkmaz. (Here)[https://www.behance.net/gallery/26425031/Vespa-Responsive-Redesign] you can find more information about the original design of this webapp and you can also see Murat Korkmaz profile (here)[https://www.behance.net/muratk] to know more details about his wonderful work.

We would also like to thank to Microverse community for their support and motivation. They have supported us a lot in carrying out this project, giving us suggestions and good advice.

πŸ“ License

This project is MIT licensed.

The UI design of the webpage is not ours. It is under (Creative Commons License)[https://creativecommons.org/licenses/by-nc/4.0] licensed.

(back to top)

About

License:MIT License


Languages

Language:JavaScript 80.8%Language:CSS 18.3%Language:HTML 1.0%