Giter VIP home page Giter VIP logo

kindest-words's Introduction

CS35L Final Project - Kindest Words

Purpose

Kindest Words is an app created to anonymously connect individuals together in order to create a safe place to vent or ask for advice, without judgement. Users anonymously make posts, similar to forums, to which people can reply.

Main Features

  1. User accounts with the ability to sign up and login.
  2. Posting requests and posting replies to requests, in a similar manner to a forum. Only the request author can see replies.
  3. Users can search through replies to past requests they have made.
  4. Users are sent the requests of other users in order to reply.
  5. Reporting system that flags the reported user, making them unable to login
  6. Background music feature, which can be paused

Running the App

Install node.js by running the following command on linux:

sudo apt install nodejs

in your home directory.

OR

if on macOS or Windows, go to https://nodejs.org/en/ and install node.js

Clone the repository:

git clone https://github.com/DiyaBaliga/kindest-words

cd kindest-words

Then run

npm install

In order to run the app

Create a .env file in the client folder. In it, paste: SERVER_URL = http://[insert your public ip address]:3000

Create a .env file in the server folder. This will allow you to connect to the database. In it, paste: DB = mongodb+srv://admin:[email protected]/myFirstDatabase?retryWrites=true&w=majority

cd server

npm run dev

This starts the client and server simultaneously. In order to run the app on iOS, install Expo Go and scan the QR code that Expo gives you in your desktop browser.

Notes

Github users stsang333 and Spencer Sang are the same person.

This app takes inspiration from a Steam game called "Kind Words (lo fi chill beats to write to)".

The url to the background music is https://www.youtube.com/watch?v=1tUPFQ54gqc&t=726s

kindest-words's People

Contributors

diyabaliga avatar amyh11325 avatar dawang423 avatar marksc1888 avatar stsang333 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.