Safer Spaces

A community based way to vet the venues you and your friends frequent

README.md created using MakeMeTakeMeReadMe

• Requirements • Setup • Technologies • Contributors • Bugs • Cloning • AppSettings • Database

About this project:

PROJECT IMAGES

REQUIREMENTS

Visual Studio Code

MySql Workbench

.Net Core v2.2

SETUP

CLONING

• Copy the repo link as shown in the image below

• Paste the link in the field provided by VsCode as thown in the image below

• You will be prompted to open the directory once you have cloned it. Select 'open'

APP SETTINGS

You need to update your username and password in the appsettings.json file.

By default these are set to user:root and an empty password. If you are unsure, refer to the settings for your MySqlWorkbench.

OBTAINING AN API KEY

In order to use this project, you will need to obtain an API key from the Google Places public API. You can find instructions for this process here: Google Places API. Once you obtain the key, you will create a file in the Models directory of SaferSpacesApi called EnvironmentVariables.cs and copy paste the following code into the file, replacing [YOUR-API-KEY-HERE] with your actual Google Places API key.

{
  public static class EnvironmentVariables
  {
    public static string ApiKey = "[YOUR-API-KEY-HERE]";
  }
}

DATABASE WITH MIGRATIONS

with the root project folder open in your code editor, execute the following in your terminal:

cd ProjectName

dotnet restore

dotnet build

dotnet ef database update

dotnet watch run

TECHNOLOGIES USED

C#

CSS

Bootstrap

Bootswatch

Asp.Net MVC

HTML

Visual Studio Code

MySql Workbench

MVP Goals

Goal	Completed(Y/N?)	Notes
About section on Home Index View with details about project	Y	Add About section
Create database, seed data with clubs, bars, et.	Y	Removed once Google Places Api was implemented
Create a class for Place, Event and Testimonials	Y	n/a
Search by common elements such as venue or address to bring up list view of nearby nightlife	Y	n/a
Click on a locationto view its details (name, place type, address, description, % of testimonials)	Partial	Place details show, link to add testimonials and events show, but unable to add testimonials and events at this time so cannot view %
User can log in or register and log off	Y	n/a
Use authorization to redirect to login page if user tries to post a testimonial / event while not logged in	Not yet	Need to add authorization to routes
Add a testimonial or event to a place	Not yet	Able to view form, unable to post at this time

Specifications Stretch Goals

Goal	Completed(Y/N?)
Refuge Restroom API	Not yet
More safety details	Not yet
Email verification (OAuth) and notifications	Not yet
Ability to follow businesses	Not yet
Add pagination Api and Frontend/Infinite Scroll	Not yet
Add message if user tries to register a registered user	Not yet

KNOWN BUGS

AddTestimonials and AddEvents forms currently do not post to API as of: 8/27/2020

❤️Contributors

|
_{Brittany Lindgren}

|
_{Erich Richter}

|
_{Jason Khan}

|
_{Mariel Hamson}

safety community bars restaurants