Skip to content

jusoffiati/VibeMap

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

VibeMap 🗺

Welcome to VibeMap, a platform that allows users to create personalised maps according to their interests. Whether they’re into art, history, food or nature, VibeMap lets users create their own maps by filtering the spots that match their personality.

Screenshot 2023-07-11 at 20 41 12 Screenshot 2023-07-11 at 20 44 30 Screenshot 2023-07-11 at 20 45 38

Getting Started

Install dependencies on the client and server side with npm i

In the root of the server folder -> create a .env and include your variables e.g.


DATABASE_HOST=<localhost>
DATABASE_USERNAME=<your-username>
DATABASE_PASSWORD=<your-password>
DATABASE_NAME=<your-db-name>
DATABASE_PORT="5432"

To use ElephantQL as the platform to host your database, create a new instance, then click on the newly created instance and select -> Details. There you will see your database access credentials. You can then copy these to your server ‘.env’ file.

In the root of the client -> create a .env and include your Google Maps API Key e.g.


REACT_APP_GOOGLE_MAP_API_KEY=<your-API-key>

Run the server with node index.js and the client with npm start.

To create a Google Maps API key, see below:

  1. Go to the Google Maps Platform > Credentials page. GO TO THE CREDENTIALS PAGE

  2. On the Credentials page, click Create credentials > API key.The API key created dialog displays your newly created API key.

  3. Click Close.The new API key is listed on the Credentials page under API keys. Remember to restrict the API  key before using it in production.

For more information on how to set up your Google Maps API key, click here

Tech Stack

Frontend

React Tailwind CSS Daisy UI Flowbite

Backend

Express Node.js

Database

Sequelize PostgreSQL

About

Codeworks Solo Project

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published