/Kraya-Anti

Placed First Runner-Up in Hack-it-Out '20, IIT Patna's premier Hackathon. A React and Node/Express based project aiming to help out small scale industries and businesses.

Primary LanguageJavaScriptMIT LicenseMIT

Kraya-Anti


"Bridging the gap between Traders and Distributors"

🚀 Deployment Status

📫 Idea Abstract

📝 Table of contents

🔍 About This Project :


This Website provides traders a simplified map based platform to look for distributors who are near to them so that desired goods be supplied at a reasonable price.

Built With :

Following are the frameworks, libraries and languages used in this project :

💻 User Interface Design

  • Login Page

  • Sign-Up Page

  • Profile Page

  • Trader Section

  • Distributor Section

✅ Features


  • Trader/Distributor registration and login
  • Manufactured/Raw Classification
  • Map Based Location
  • Map API based approx. transport costs/sorting possibility
  • Trader to-do list
  • Filter based Item selections
  • Ability for distributors to add items catalogue
  • Workforce integration opportunities
  • Trader based review and administrative involvement
  • Orders Placed History
  • Orders Placement

🚀 Installation

Pre-requisites :

1. Make sure you have mysql, nodejs, and react-express installed.
To install mysql, nodejs and react-express refer the following links :
2. Choose a good text-editor to initiate the project( Visual studio Code is recommended).
3. Make sure that your MySQL server is set to legacy configuration to avoid errors while initiating the project.
4. Read backend.md to see how to set up mysql login for the app

Front End Initiation :

1. You can either install the project in zip format from our github or clone the repository using the following link in your local directory : 
    git clone https://github.com/Spirit-ofJoy/Celesta.git

  1. After installing the project, extract it if you have preferred installing it in zip format and open the front end sub folder in Visual Studio Code( Considering that the default text editor is Visual Studio Code). Following this open a new terminal by using the following command :
    Ctrl+Shift+`

  1. In the terminal run the following command to install the required node modules for front end initiation :
    npm install

  1. Module installation will take 2 to 3 minutes depending upon your network connectivity. After all the required modules have been installed, run the following command to initiate the project :
    npm start

Back End Initiation :

  1. Open the backend folder in Visual Studio Code, the same way you opened the Front End folder. Following this open a new terminal either by clicking terminal, then "New Terminal" on the top Menu Bar or run the following command :
    Ctrl+Shift+`
  1. In the terminal run the following command to install the required node modules for back end initiation :
    npm install
  1. Module installation will take 2 to 3 minutes depending upon your network connectivity. After all the required modules have been installed, run the following command to initiate the project :
    npm start

🤝 Report a Bug / Recommend a new feature :

Feel free to file a new issue with a respective title and description on the Kraya-Anti repository. If you already found a solution to your problem, we would love to review your pull request!

❤️ Contributing

Contributions are what makes the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📘 License

Distributed under the MIT License. See LICENSE for more information.

Developers

Back to top