Code Monkey home page Code Monkey logo

chupacabra's Introduction

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

chupacabra's People

Contributors

abpozharliev19 avatar aemanov20 avatar idiliev18 avatar iidimov18 avatar kntaligadzhiev19 avatar mmmarinov20 avatar ssivanov19 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

chupacabra's Issues

Create footer

Description

Create footer, that will show on every page.

Due Date

2021-06-08

Chupacabra Logo

Impelemt nodemailer

Description

Impelled nodemailer, to send verification emails.

Due Date

2021-06-28

Chupacabra Logo

Add username regex

Description

Make regex for username (a-z, [.], [-], [_])

Due Date

2021-06-14

Chupacabra Logo

Implement JSDoc

Description

Implement JSDoc in all js files.

Due Date

2021-06-28

Chupacabra Logo

Make validations

Description

Make function which validates the input from the forms

Due Date

2021-06-21

Chupacabra Logo

Make Users Table

Description

Make Users Table in the database

Due Date

2021-06-10

Chupacabra Logo

Make documentation

Description

Make documentation of the project in MS Word.

Due Date

2021-062-28

Chupacabra Logo

Refactor Register Code

Description

Refactor register code, so it is more easily readable

Due Date

2021-06-30

Chupacabra Logo

Add logs

Description

Send logs when there is a problem with validation.

Chupacabra Logo

Refactor Boat Code

Description

Refactor boat code, so it is more easily readable.

Due Date

2021-06-30

Chupacabra Logo

Make login form

Description

Make a login form. Username/ Email and Password needed

Due Date

2021-06-16

Chupacabra Logo

Create stored procedure for user registration

Description

Write a stored procedure, where you should check is Email or Username or Phone is taken. If one or more of this is taken, return error code. If everything is ok insert the data into the db and returns token expiration date

Return Code:

  • 0 - Success
  • 1 - Taken Email
  • 2 - Taken Username
  • 3 - Taken Phone

Due Date

2021-06-16

Chupacabra Logo

Add new things in Readme.md

Description

Add new things in Readme.md:

  • Add GIFs
  • Add more detailed deployment
  • Add .env data

Due Date

2021-06-30

Chupacabra Logo

Make Readme

Description

Make Readme.md in repo.

Due Date

2021-06-08

Chupacabra Logo

Presentation

Description

Create presentation

Due Date

2021-06-08

Chupacabra Logo

Make wiki

Description

Make wiki in GitHub

Due Date

2021-06-28

Chupacabra Logo

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.