Skip to content

Latest commit

 

History

History
109 lines (92 loc) · 5.6 KB

README.md

File metadata and controls

109 lines (92 loc) · 5.6 KB
Raw

Safe Space

  • Safe Space is a journaling/diary web application that aims to bring people together through transparent entry creations and letter sending.
  • A Wi-Fi connection and enabling Javascript in the browser is required to get the best experience from the web application.
  • The application is currently deployed and can be found through this link: https://safespace-ph.herokuapp.com/
  • Instructions to run the web application locally can be found below.

Contributors

Dependencies

Dev Dependencies

Third Party Libraries Used

Instructions when Running Web Application Locally

  1. Clone the repository by using the command below (note: git should be installed in your system for this to work).
git clone https://github.com/DLSU-CCAPDEV/2021T2-G30.git

  1. Open Command Prompt

  2. Navigate to the project folder - the folder containing the contents of the cloned or downloaded repository.

  3. Run the command npm install to initialize and install all necessary modules used in the project.

  4. Run the server by typing running the command npm run start. Upon running the command, your Command Prompt should display the following statement:

Server running at:
http://localhost:3000/login
  1. Go to the link below to access the web applcation:
http://localhost:3000/login
  1. Note: A Wi-Fi connection is required to run the application since it uses libraries sourced from the internet. You must also create a .env file with the following format to run the application successfully:
HOSTNAME=localhost
PORT=3000
DB_URL=<database link>

Safe Space Features

  • Features - Safe Space's list of features can be viewed through this link.

Images used for creating Dummy Data

Copyright Disclaimer under section 107 of the Copyright Act 1976, allowance is made for “fair use” for purposes such as criticism, comment, news reporting, teaching, scholarship, education and research. Fair use is a use permitted by copyright statute that might otherwise be infringing. Non-profit, educational or personal use tips the balance in favor of fair use.