Skip to content

Nano-AI/litter.ly

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

79 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


Logo

LITTER.LY

A social networking platform to create a cleaner world. Made for the 2023 HackPNW event.

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Check it out here on Devpost!

A social media platform meant to make it easier to organize and promote events driven to help clean the community.

(back to top)

Built With

  • Express
  • ReactJS
  • Material UI
  • Bootstrap
  • Leaflet
  • TaffyDB

(back to top)

Getting Started

Install Node.JS, and make sure it's added to path.

Installation

Clone the repo, and npm install the appropriate packages.

git clone https://github.com/Nano-AI/HackPNW-2023.git
cd backend && npm i
cd frontend/hackpnw-2023 && npm i

If the program is being tested, go to about:config (for FireFox), and set security.fileuri.strict_origin_policy to false to disable any CORS errors.

Then, go to HackPNW-2023/frontend/hackpnw-2023/src/api/Database.js, and change the ngrock_url variable to the url if your API (the code setup in /backend).

(back to top)

Usage

Have two separate terminal prompts open and run npm start in the frontend and backend directories.

(back to top)

Roadmap

  • Feature 1
  • Feature 2
  • Feature 3
    • Nested Feature

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

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

(back to top)

About

2023 HackPNW Hackathon

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors