Home

Welcome to the SharedDaily wiki!

Today we will be walking you through on how to setup your development environment so you can contribute to the project

(1) Clone the repository (use your preferred method)

  git clone https://github.com/bryanmontalvan/shareddaily.git
  cd shareddaily

The first command will clone this project to your system
The second command is optional, if you are using a terminal then this command is used to move into the shareddaily directory (where the code lives)
From here on open your editor of choice and start hacking away

(2) Install NPM and run the application

  npm install
  npm run dev

Note: For this part you will need the terminal

The first command will install all the dependencies, packages, and libraries the project uses
The second command will run a local test environment for you to access the website
- In this test environment you will be able to test your changes and the website itself

Now you're all set with installing the frontend! Now its a good time for you to learn about the technologies we use to better understand the code.

(1) Intro to our database

For the backend we use RedisCloud as both our Database and its host.
Meaning that we have an instance of RedisDB hosted on an AWS-server provided by RedisCloud

What does this mean for you? There are two routes you can take to run the backend

Building the Redis instance locally will let you skip using the Redis suite
Making a RedisCloud account and using their Cloud suite will allow you to use tools like RedisInsight which is a great GUI tool for viewing your database.

(2) Add your Redis environment variable to code

# .env.local
REDIS_URL=redis://default:<PASSWORD>@<PUBLIC ENDPOINT>:<PORT NUMBER>

From here the lib/redis.js file should now communicate to the data-base and now your backend is all set!