Skip to content
This repository was archived by the owner on Sep 25, 2021. It is now read-only.

project-aura/client

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Client

Project that acts as a business finder (mainly for restaurants). It is not intended for distribution, yet; it is merely a demonstration of skill using web technologies for potential recruiters.

Build Status

Netlify Status

Motivation

During training at Talent Path, we were tasked to create a web solution using the technologies we were learning. We believed that many business finders gave you hard facts about the business, but not how a person felt when they visited that business. Aura attempts to capture the "aura" (vibe) of a business to provide a better search experience.

[Insert something about Agile and business practices here.]

Tech/Frameworks used

Special thanks to the wonderful people that have created all the following technologies. If any packages are included but not mentioned, then they will be in the package.json. ❤️

  • React.js: A JavaScript library for building user interfaces
  • Create React App: A modern build setup with no configuration for react applications.
  • Axios: Promise based HTTP client for the browser and node.js
  • Sweet Alert 2: A beautiful, responsive, customizable, accessible replacement for JavaScript's popup boxes.
  • FontAwesome: Vector icons and social logos
  • Jsonwebtoken: JsonWebToken implementation for Node.js

Screenshots

Example screenshots of the application.

Home

Home Display

Search Results

Search Results Display

Code Style

Developed in Visual Studio Code.

  • Linted with Eslint
  • Code styled with Prettier

Features

[Insert list of features here]

Roadmap Features

[Insert list of future features here]

Project setup

This project was started with Create React App. Please refer to their documentation on how to start a react application (if you are interested).

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.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: Code Splitting

Analyzing the Bundle Size

This section has moved here: Analyzing the Bundle Size

Making a Progressive Web App

This section has moved here: Making a Progressive Web App

Advanced Configuration

This section has moved here: Advanced Configuration

Deployment

This section has moved here: Deployment

npm run build fails to minify

This section has moved here: npm run build fails to minify

Contributing Guide

Running Locally

"Run" = execute command in your terminal / command line

  1. Clone this repository to your local machine
  2. Run npm install in your project directory to get all necessary node modules to run the project.
  3. Request the .env file from one of the owners to get the necessary configurations.
  4. Place the .env file in the root of the project folder.
  5. Run npm start to begin the fun!

Requesting Changes

If you do plan on making changes to the project, make sure you create a new branch and make a pull request first.

We have protected our code branches and require a pull request review before merging code.

Credits

Special thanks to Talent Path for supporting us to make this project and giving us the resources to succeed in our careers.

License

MIT © - Aura

Last Updated

June 14, 2019

About

Front-end application

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 7