chufnagel / wanderer

Wanderer: A Social Travel Diary

Team

• Product Owner: Mandy Mak
• Scrum Master: Charles Hufnagel
• Development Team Members: Koichi Sakamaki, Lina Lei

Table of Contents

1. Usage
2. Description
3. Requirements
4. Development
   1. Installing Dependencies
   2. Tasks
5. Team
6. Contributing

Description

A social network aimed at travelers looking for new places to travel around the world. Built using React, Redux, Material-UI, Express, and MySQL.

Run behind an Nginx reverse proxy in production. HTTPS certification through LetsEncrypt. CI through Travis CI.

Leverages the Google Places API and Atlas Obscura to find sites of local prominence and any unexplored gems.

Usage

Environmental variables are set in .env (See .env.example) Database defaults to MySQL/Maria, but can be easily substituted with Postgres, Sqlite3, etc. (See Knex.js docs for more information) Use the Knex CLI or the package.json migrate and seed scripts to import the schema and add demo data.

The app is presently deployed at https://charles-hufnagel.com

Requirements

• Node.js 10.5.0 or higher, NPM || Yarn
• MariaDB 10.3.7 || MySql 8.0.11
• Knex.js CLI

Development

Installing Dependencies

From within the root directory:

For a production build:

npm install
npm start

For a development build (with hot reloading)

npm run dev

Roadmap

View the project roadmap here

Contributing

See CONTRIBUTING.md for contribution guidelines.