World Surf Journal

Save your next surf adventure...

Demo . Report Bug

Introduction

The world surf journal is a web application that allows the user to register an account and save their surf trips with various details and rating. It was carried out over the course of three days and part of the final checkpoint while enrolled on a Web Development course at the Wild Code School. It is a fullstack application and consists of a frontend, backend and database.

Contents

• World Surf Journal
  • Introduction
  • Contents
  • Main Features
  • Project Status
  • Future Development
  • Deployment
  • Technologies
  • Installation
  • Contribution

Main Features

Some of the main features of this project are:

• The ability for the user to register a new account.
• The ability for the user to securely sign into their account.
• The ability for the user to log out securely.
• The ability for the user to add a surf trip and save it to their account.
• The ability for the user to view all their trips in an easy accessible dashboard.
• The ability to expand each trip within the dashboard and view extra information about their trip.
• The ability for the user to edit a trip.
• The ability for the user to delete their trips.

Project Status

The project was completed and handed in within the time frame allocated by the school, the project meet all requested requirements.

The project was the final checkpoint of the web development course and it was created over the course of three days.

I would like to continue working on the project into the future.

Future Development

Some of the main features to add in the future are :

• The ability for the user to update their profile.
• The ability for the user to upload an image to their trip.
• The ability for the user to view all their trips on a aesthetically pleasing map, with expandable icons etc...
• The ability for the user to order a physical map of their trips.
• The ability for the user to share their trips on other social media platforms.

The above list is a few of the main future developments.

Deployment

The project has been deployed and is fully functional, but is currently on a free plan on railway:

• https://railway.app/

The deployed version consists of a frontend, backend and database. It can be found at the following:

• https://worldsurfjournal-production.up.railway.app/

Technologies

To develope the World Surf Journal fullstack application the following technologies were used:

• Frontend
  • CSS, JavaScript, React
• Backend
  • Node.js, Express
• Database
  • MySQL

Installation

The project was created using React for the frontend and Node.js for the backend.

It can be set-up by the following

• First:

  • git clone
  • git@github.com:Billy-Night/world_surf_journal.git

• Second:

  • npm install

This will install all the dependencies.

• Third:
  • npm start

This will launch the frontend, but it still needs to be connected to the backend, which can be found at the following:

• Fourth:
  • git@github.com:Billy-Night/world_surf_journal_backend.git

After this the backend will need to be connected to the database, the database script can be found within the backend folder as the following: wsj_db.sql .

Contribution

If you have any questions please contact the creator at: https://github.com/Billy-Night