Umbrella

Post-It Note Murals for Social Activists

About the Project

Umbrella is a platform for social activists to spread messages in a Post-It note style virtual Lennon Wall. Features draggable sticky notes and options to create messages with text or drawings.

The Stack

• React app with Chakra UI
• Node.js/Express server
• Firebase Realtime Database
• Statically deployed with Vercel

🚨 At the moment, there is no functional back-end due to issues integrating with Firebase DB. Use the static branch to run without the Node server.

Setup

Because this app is made of two npm projects, there are two places to run npm commands:

1. Node API server at the root ./
2. React UI in react-ui/ directory.

Run the API server

In a terminal:

# Initial setup
npm install

# Start the server
npm start

Install new npm packages for Node

npm install package-name --save

Run the React UI

The React app is configured to proxy backend requests to the local Node server. (See "proxy" config)

In a separate terminal from the API server, start the UI:

# Always change directory, first
cd react-ui/

# Initial setup
npm install

# Start the server
npm start

Install new npm packages for React UI

# Always change directory, first
cd react-ui/

npm install package-name --save

Contributing

Contributions are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

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