Skip to content

AjayLiu/inspiration-jar

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Logo

Inspiration Jar

A platform for humans around the world to share and read words of encouragement!
Website »

Table of Contents
  1. About The Project
  2. Getting Started
  3. License
  4. Contact
  5. Acknowledgements

About The Project

I got the inspiration to make this project when I gave my dad a similar gift for our Christmas 2020 gift exchange. I wrote words of encouragement on little pieces of paper and put them in a jar, which you can take and read if you need.

Built With

Frontend:

Backend:

Getting Started

Here is a guide if you want to clone my website and modify it for yourself, all the way to deployment.

Prerequisites

Installation

  1. Clone the repo
    git clone https://github.com/AjayLiu/inspiration-jar.git
  2. Install packages
    yarn
    cd client
    yarn
    cd ../server
    yarn
  3. Create a PostgreSQL databse (I used AWS)
  4. Create a .env file in the /server folder and fill in the following info for the backend to function properly (PG = postgres)
    PG_HOST =
    PG_DATABASE =  
    PG_USER = 
    PG_PORT = 
    PG_PASSWORD =
    DATABASE_URL=
    
    GOOGLE_CLIENT_ID = 
    GOOGLE_CLIENT_SECRET = 
    
    SESS_NAME = (doesnt really matter)
    SESS_SECRET = (some random gibberish)
    
    DISCORD_WEBHOOK_URL = 
    
    ADMIN_EMAIL =
    

Development

To run the development server

yarn dev

Then head over to localhost:3000

Deployment

Using Heroku:

  1. Publish the site on Heroku using continuous git integration.
  2. Enter in the environment variables (.env) in Heroku via Heroku's CLI or through the website dashboard.

Using Render:

  1. Publish the site on Render using continuous git integration.
  2. Paste the contents of your .env file into Render's environment tab.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Ajay Liu - contact@ajayliu.com

Project Link: https://github.com/AjayLiu/inspiration-jar

Acknowledgements

About

Share words of encouragement anonymously! Improved version of the original Inspiration Jar

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published