Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ronaldleung1/umbrella
☂️ A platform to create Post-It note murals
https://github.com/ronaldleung1/umbrella
Last synced: about 19 hours ago
JSON representation
☂️ A platform to create Post-It note murals
- Host: GitHub
- URL: https://github.com/ronaldleung1/umbrella
- Owner: ronaldleung1
- License: mit
- Created: 2021-01-30T14:11:30.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-12T19:33:00.000Z (almost 2 years ago)
- Last Synced: 2024-05-20T12:11:47.878Z (8 months ago)
- Language: JavaScript
- Homepage: https://useumbrella.now.sh
- Size: 1.81 MB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-hackclub - umbrella - [@googol88](https://github.com/googol88) - **(JavaScript)** _☂️ A platform for social activists to create Post-It note murals_ (Web Apps)
README
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](https://github.com/facebook/react) with [Chakra UI](https://github.com/chakra-ui/chakra-ui)
- Node.js/Express server
- [Firebase Realtime Database](https://firebase.google.com/docs/database)
- Statically deployed with [Vercel](https://vercel.com/)
> 🚨 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 `./`
1. **React UI** in `react-ui/` directory.
### Run the API server
In a terminal:
```bash
# Initial setup
npm install
# Start the server
npm start
```
#### Install new npm packages for Node
```bash
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](react-ui/package.json))
In a separate terminal from the API server, start the UI:
```bash
# Always change directory, first
cd react-ui/
# Initial setup
npm install
# Start the server
npm start
```
#### Install new npm packages for React UI
```bash
# 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`](/LICENSE) for more information.