README.md

School Petition App

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Features
  • 🚀 Screen Shots
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
  • Usage
  • Deployment
• 👥 Authors
• 🤝 Contributing
• ⭐️ Show your support
• 📝 Acknoledgements

📊School Petition App

School petition app is built to empower students, teachers, and staff to create, sign, and share petitions effortlessly.

🛠 Built With

Tech Stack

Client

• React JS

Server

• Express.js
• Node js

Database

• Mongo DB

Features

• Users can easily create an account with a unique username and password and xisting users can securely log in to their accounts
• Users can start new petitions to raise awareness about an issues or propose changes within the school community
• Authenticated users can show their support for a petition by signing it and also leave comments
• Users have a profile page displaying their created petitions and supported petitions. They can also edit details on their profile

Screenshots

Signup Page

Page to Start a Petition

User Profile

Browse Petitions

Sign a Petition

Home Page

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

• Node
• NPM or Yarn
• Mongo DB account

Setup

Clone this repository to your desired folder:

  cd your-folder
  git clone https://github.com/ceeriil/petition.git

Install

Install this project with:

 npm install
 npm install -g nodemon

Usage

To run the project, execute the following command:

Start the server

  npm start

Run the Frontend

  npm client

Then Open URL "https://localhost:3000" on a browser.

Deployment

You can deploy the program on any hosting service supporting node js

👥 Authors

👤 Simon Cyril

• GitHub: @ceeriil
• Twitter: @ceeriil

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

⭐️ Show your support

If you like this project feel free to message me on twitter

ACKNOLEDGEMENTS

I would like to express my sincere gratitude to Athul Vinod, whose repository served as the foundation for this project

(back to top)