C0de010gy

Welcome to C0de010gy, an event management system for non-profits! A previous version of this project (through this commit) was a semester-long project for a graduate-level university course.
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Contributing
4. License
5. Contact
6. Acknowledgements

About The Project

A previous version of this project (through this commit) was a semester-long project for a graduate-level university course. It is designed as an event management system for non-profit organizations, allowing scheduling of events with locations, times, etc. In addition, it allows individuals to volunteer to help out for events, and make donations to specific events or the organization as a whole.

Built With

This project is written in Node.js for the backend and React.js for the frontend, with the use of some other packages to aid development.

• Node.js
• React.js
• React Material Design Library
• Mariadb

Getting Started

For now, there is no installer or prepackaged installation for this project. Follow the instructions below to get the project running on your system.

Installation

1. Clone the repo

   git clone https://github.com/Bennett-Wendorf/C0de010gy.git

2. Install dependencies

   • In the frontend directory use npm to install the requirements for the frontend.

     cd frontend
     npm install

   • Then do the same for the backend.

     cd ../backend
     npm install

   OR

   • If you wish to use the application as is, you only need to install the backend requirements, as the build directory in the backend will host the pages for the frontend.

3. Run the app

   • If you wish to run the prebuilt frontend from the backend, you can do the following to run the backend server and host the frontend from it.

     cd backend
     npm start

   OR

   • If you wish to run the backend and frontend separately, do the following in two separate terminals:

     cd frontend
     npm start

     cd backend
     npm run dev OR npm start

4. Create your own frontend build

   • You can also check out this guide on how to create that build folder if you make modifications to the frontend.

Contributing

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

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

If you find an issue in existing code, feel free to use the above procedure to generate a change, or open an issue for me to fix it.

License

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

Contact

Bennett Wendorf - Website - bennettwendorf@gmail.com

Project Link: https://github.com/Bennett-Wendorf/C0de010gy

Acknowledgements

• Img Shields
• Node.js
• React.js
• React Material Design Library
• Mariadb
• Create React App