/chupacabra

Web application for managing ports.

Primary LanguageJavaScriptGNU General Public License v3.0GPL-3.0

logo

CHUPACABRA

The innovative solution for every port in the world. 💧

💻 About

Our website systematizes, organizes and facilitates the work of the workers in the ports and gives the citizens access to useful information.

Our Documentation

🎥 Demo of our project

⌨️ How it works

Our work can be split into 2 main things :

  1. 👨‍💻 Back end - JavaScript :
    • We use OOP Javascript for our backend as we have different classes for the different use cases
    • We transfer the data through the node-mssql module
    • Then the backend operates with the data sent from the DB

  2. Front end - React with Bulma
    • Bulma is CSS framework that is build on flexbox and grid system and create fully responsive webpage.
    • Combined with React - a library from Facebook
    • And we get a powerful tool used for building out website

    📥 Deploying

    To deploy our project on your machine you need to follow these steps:
    1. Clone it. This can be done by: 

    git clone https://github.com/idiliev18/chupacabra.git
    2. Navigate to the root folder: 
    cd chupacabra
    3. Create .env file: 
    LOKI_IP=<IP of the loke server>
DISCORD_ID=<ID of the discord webhook>
DISCORD_TOKEN=<Token of the discord webhook>
DB_USER=<Database ssername>
DB_PASSWORD=<Database password>
DB_SERVER=<Database server>
DB=<Database name>
saltRounds=<Salt round> 
MAX_REQUEST_COUNT=<Max number of requests>
GMAILID=<Gmail email to send emails>
GMAILPASS=<Gmail password>
    4. Navigate to the server folder: 
    cd server
    5. Install the node modules: 
    npm install
    6. Start the server 
    node app.js
    7. In an new terminal, open client folder 
    cd client
    8. Install the node modules (might take some time): 
    npm install
    9. Start the react app 
    npm start

    🧒 Our Team

    Iliyan Iliev - IDIliev18 - Scrum trainer

    Stoyan Ivanov - SSIvanov19 - Back-end Developer

    Ivan Dimov - IIDimov18 - Back-end Developer

    Atanas Pozharliev - ABPozharliev19 - Back-end Developer

    Kostadin Taligadzhiev - KNTaligadzhiev19 - Designer

    Alexander Manov - AEManov20 - Front-end Developer

    Maxim Marinov - MMMarinov20 - Front-end Developer