Skip to content

Latest commit

 

History

History
133 lines (86 loc) · 8 KB

README.md

File metadata and controls

133 lines (86 loc) · 8 KB

Bon Appetit

A full-stack restaurant tracker application

GitHub language count GitHub top language GitHub code size in bytes GitHub repo size in bytes GitHub issues GitHub closed issues

Contents

Contents
  1. About This Project
  2. Built With
  3. Technical Aspects
  4. Upcoming Features
  5. Deployment
  6. Getting Started with Create React App
  7. Acknowledgements
  8. Connect With Me

About This Project

This full-stack restaurant tracker and review application has a custom-built RESTful API using Express and allows for CRUD actions. It is powered by relational databases using PostgreSQL.

Bon Appetit Image 1

Bon Appetit Image 2

Bon Appetit Image 3

Built With

bootstrap css3 express git heroku html5 javascript jest nodejs postgresql postman react

Technical Aspects

  • Fullstack app using JavaScript, React, CSS, Node, Express
  • Use ES6 namespacing principles to adhere to good architecture practices
  • Minimal global variables
  • Create modules in separate files to organize your code
  • Follows the React-ful design pattern
  • Conditional rendering in React
  • Use of context and state management in React
  • Aligns with RESTful API guidelines
  • Follows a11y best practices
  • Deployment using Vercel

Upcoming Features

For a list of upcoming features and bug fixes that are good for beginner developers looking to contribute, check the Issues tab of this repo.

Deployment

  • Client deployed with Vercel
  • Server deployed with Heroku
  • You can view the source code for the server and database at this repo.

Getting Started with Create React App

This project was bootstrapped with Create React App.

Available Scripts

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.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

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!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

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.

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.

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.

Acknowledgements

Connect With Me

🔭 I’m currently working on mastering data structures and complex algorithms.

🌱 I’m currently learning the fundamentals of Angular.

🤝 I’m looking for help with networking as a new dev in the community.

👨‍💻 All of my projects are available here

💬 Ask me about the ease of the PERN stack.

📫 The best way to reach me is by email: [email protected]

📄 Check out my resume of experiences

⚡ Fun fact Hiatus Kaiyote is my favorite band at the moment.

elina-mcgill