Amphi

By: Sam Bassong

Porfolio | LinkedIn | GitHub

Description

Amphi is an events search application and database built on the MERN stack (MongoDB/Express/React/Node.js). I built this light application to learn the various pieces of the stack. First full-stack app!

Technologies Used

MongoDB - Document-oriented database
Express.js - Web framework for Node.js
React (bootstrapped with Create-react-app)
Node.js - JS runtime
Heroku - Deployment host

Local Environment Requirements

Node, npm, and MongoDB are necessary to run this application. Please follow the installation guidelines in the Env-requirements section section if needed.

Getting Started

Once the requirements are met, we're ready to run the application. Follow the steps below to set up and launch the application server.

Copy this repo's HTTPS URL and clone it onto your local machine's terminal:

git clone https://github.com/sbassong/amphi.git

From here you will need to have 2 terminals open to run both the frontend and backend

A. Client / React app / Frontend

Change directory into the newly cloned folder's client folder then install dependencies
```
cd amphi/client
npm install
```
Run the app on port 3000
```
npm start
```

B. Server + Database / Express app / MongoDB / Backend

Change directory into the newly cloned folder then install dependencies
```
cd amphi
npm install
```
(optional) Seed the artists and event data
```
npm run seed
```
Run the server
```
npm run dev
```

Credits

inspiration: Ticketmaster/ticketweb

Pictures: DuckDuckGoSearch

artist description: Wikipedia

icons: React-icons

random data: Faker API

Env Requirements

Node, npm, and MongoDb are necessary to run this application. please follow the installation guidelines below:

Node and npm

Recommended: Go to the Node Version Manager (NVM) github and follow the instructions to install both both Node and npm
Alternatively: Go to Node.js and use the installer appropriate for your system to install node and npm

Verify that both node and npm have been installed by running the following in your CLI
```
  node -v
  npm -v
```

MongoDB

Head to the official MongoDB documentation as needed, choose your operating system family and follow your preferred installation route
My preferred installation method for Linux/MacOS:
1. install homebrew by running this command in your termninal
```
 /bin/bash -c "$(curl -fsSL https://raw githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```
2. follow this each of the following line one by one
```
 brew tap mongodb/brew

 brew tap | grep mongodb

 brew install mongodb/brew/mongodb-community
```
  To start Mongo and keep it running on your machine
```
 brew services start mongodb/brew/mongodb-community
```
  To open the mongo shell, run
```
 mongosh
```
  The CLI should throw a few lines, then prompt with test>
  
  Create your first database with
```
use <nameOfMyFirstDatabase>
```
  Exit the shell with:
```
exit
```
Check out MongoDB docs for database operations and more

sbassong / amphi Goto Github PK

amphi's Introduction