citizenConnect360

I am building this project to educate the general masses on government documents (e.g bills being discussed in parliament), Facilitate issue reporting and feedback to the government. It will utilize AI to analyze citizen input and support informed decision-making generally promoting citizen engagement and government responsiveness.

Contributing to citizenConnect360

Follow these steps to begin contributing:

• Bug fixes are always welcome. Start by reviewing the list of bugs.
• A good way to easily start contributing is to pick and work on a good first issue. I try to make these issues as clear as possible and provide basic info on how the code should be changed, and if something is unclear feel free to ask for more information on the issue. I will respond as soon as I can.

How to Contribute

Prerequisites.

1. You need to have MsSQL installed and running on your local machine
2. You need to have a Python compiler and a C/C++ compiler on your local machine

1. Fork the repository by clicking on the Fork button in the main repository page.

2. Clone your forked repository into your local machine.

    $ git clone https://github.com/<username>/citizenConnect360/

1. Navigate into the directory. The project requires 3 servers running simultaneously, as such it would be best to open up 3 terminals.

    $ cd citizenConnect

Terminal 1

• Navigate to the backend repository

    $ cd backend

• Open the project on your favourite text editor and input your environment variables. Copy values from the .env.example and create a new file .env inputting your values.

• Install all the neccessary dependencies and packages.

    $ npm install

• Run the server

    $ npm start

Terminal 2

• Navigate to the backgroundServices repository

    $ cd backgroundServices

• Open the project on your favourite text editor and input your environment variables. Copy values from the .env.example and create a new file .env inputting your values.

• Install all the neccessary dependencies and packages.

    $ npm install

• Run the server

    $ npm start

Terminal 3

• Navigate to the frontend repository

    $ cd frontend

• Run the ng command that installs runs the frontend webpage

    $ ng serve -o

Finally Make your changes, commit and push them to your local repository, then submit a Pull Request.