Skip to content

Latest commit

 

History

History
136 lines (98 loc) · 6.97 KB

README.md

File metadata and controls

136 lines (98 loc) · 6.97 KB

hack4impact logo
South Side Weekly

A project by Hack4Impact UIUC in collaboration with South Side Weekly

BackgroundUsageTechnologiesTeamSetupLicense

Background

South Side Weekly (SSW) is a nonprofit newspaper dedicated to supporting cultural and civic engagement on the South Side of Chicago, as well as developing emerging journalists, writers, and artists. The Weekly covers a range of topics, including politics, the arts, public interest issues, as well as poetry, fiction, and local artwork.

The majority of The Weekly's staff are volunteers, with their main contributor base coming from their readers themselves. SSW is is currently in need of a volunteer hub that can streamline the onboarding process and help volunteers and staff keep track of pitches, assignments, and contributions.

Full PRD

Usage

The latest version of this application can be found at hub.southsideweekly.com.

To install and set up locally, follow the instructions in the /client and /api directories.

Technologies

This application is built with React + Semantic UI, Typescript, Express, MongoDB/Mongoose, and tested with Cypress and Jest. Vercel is used for automatic deployment.

Team

Sahi Muthyala
Sahithi Muthyala

Product Manager
Amit Sawhney
Amit Sawhney

Technical Lead
Bryan Ge
Bryan Ge

Product Designer
Alice Fang
Alice Fang

Former Technical Lead
Mustafa Ali
Mustafa Ali

Former Product Designer
Danielle Yang
Danielle Yang

Software Developer
Eugenia Chen
Eugenia Chen

Software Developer
Aditya Jain
Aditya Jain

Software Developer
Andrew Lester
Andrew Lester

Software Developer
Neha Konjeti
Neha Konjeti

Software Developer
Andy Wong
Andy Wong

Software Developer
Zora Zhang
Zora Zhang

Software Developer
Ayan Mallik
Ayan Mallik

Software Developer

Setup

The following is a guide to run this repository.


Prerequisites

Software

Install yarn (Node.js required)

npm install --global yarn

Cloning the repository

Within a local directory of your choosing, please run either

HTTP
git clone https://github.com/hack4impact-uiuc/south-side-weekly.git
SSH
git clone [email protected]:hack4impact-uiuc/south-side-weekly.git

SSH will only work if your SSH keys are properly setup.


Creating the .env

Create a file called .env here, in the root of the api directory.

PROD_MONGO_URL=
DEV_MONGO_URL=
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
GOOGLE_CALLBACK_URL=http://localhost:9000/api/auth/redirectURI
SESS_SECRET=
[email protected]
EMAIL_PASS=
FE_URI=http://localhost:3000

For any missing fields, please reach out to Amit.


Running the app

Client

In the client directory, follow the README.md in the respective directory.

API

In the api directory, follow the README.md in the respective directory.


License

MIT licensed. Copyright © 2020 Hack4Impact UIUC.