edenroseFR / Web-based-SSIS

A web-based student information system made using Flask framework and MySQL.
MIT License
19 stars 9 forks source link
crud-flask crud-website flask flask-mysql flask-mysqldb flask-website python-flask-application python-flask-crud

CRUD WEB APPLICATION (CCC181 Assignment)

crudwebapp

FEATURES

SETUP & INSTALLATION

  1. Clone the repository to your local machine by running the following command on your command-line.
    clone 'https://github.com/edenroseFR/Web-based-SSIS.git'
  2. Install all the requirements.
    pip install -r requirements.txt
  3. Create a dotenv file.
    type nul > .env
  4. Open the .env file and write the following:
    
    DB_HOST=your_database_host
    DB_NAME=ssisdb
    DB_USERNAME=your_database_username
    DB_PASSWORD=your_database_password
    SECRET_KEY=any_string_will_do

CLOUD_NAME = your_cloudinary_name API_KEY = your_cloudinary_api_key API_SECRET = your_cloudinary_api_secretkey PHOTO_UPLOAD = cloud

5. Create a flaskenv file.
```bash
type nul > .flaskenv
  1. Open the .flaskenv file and make sure it contains the following:
    FLASK_APP=ssis
    FLASK_ENV=development
    FLASK_RUN_PORT=8080
  2. In your MySQL IDE, execute the script.sql file located in WEB_BASED_SSIS/db_script
  3. To create your own login credential, run add_admin.py. Make sure you are inside WEB_BASED_SSIS directory before executing the following:
    python add_admin.py
  4. Make sure you see the Admin added! in your console, before moving to the next step.

RUNNING THE APP

  1. Activate the virtual environment
    cd venv/Scripts/activate
  2. Run
    flask run

HOW TO CONTRIBUTE

Opening Issues

If you encounter a bug, have a question, or want to suggest an enhancement, please open an issue. Be sure to provide as much detail as possible, including steps to reproduce the issue or a clear description of your feature request.

Pull Requests

If you'd like to contribute code, feel free to submit a Pull Request to the develop branch :)