Giter Club home page Giter Club logo

stockify's Introduction

Stockify


About the Project

Made for Atmanirbhar Bharat Hackathon

This was a project intended to make the life of Warehouse owners easy by providing them with a Dashboard with clean UI and simple interface where Warehouse owner can keep a track of all their current stocks present in the Warehouse and soon the option for normal user to find near vacant Warehouses to store stuff. We intend to include features like Graphical representation of stocks present and activity charts based on previous activities of stock addition and removal. As this a Web Based Application so warehouse owners can have all their data synced across their devices.

See Live

Stockify

Technologies Used

Made on MERN Stack

This app is deployed to Heroku.


Glimpse of UI

Stock Management

live

Home Page

WelcomePage

Login Page

Login Page

Your Warehouse

Warehouse

User Profile

Profile

Watch our video to understand better

https://youtu.be/02PT4QOo84w


Getting Started

Local installation guide:

The following section will take you through the steps of setting up this app and getting it running locally on your computer.

1. Clone the repository

The first step is to clone the project repository to a local directory on your computer. To clone the repository, run the following command:

git clone https://github.com/amanjagdev/stockify.git

2. Install Node.js

If you don't already have Node.js installed on your computer, you can install the latest version here.

3. Install yarn

To be able to install the dependencies and start the application locally, you will need to install yarn. Yarn is a package manager like npm. To install yarn, run the following command:

npm install -g yarn

For more information about yarn and other installation options, see the yarn documentation: https://yarnpkg.com/en/.

4. Install the project dependencies.

Version information for each of these packages is available in the package.json file in the project root directory and in the client directory.

After you clone the repository to a local directory, change directory to the project root directory and run the following command to install the required packages:

yarn install

5. Generate MongoDb Connection URI

Sign in here https://www.mongodb.com/cloud to generate your connection string.

Get your connection string from MongoDB Atlas by following these steps:

  1. In the Clusters view, click the Connect button for the cluster to which you want to connect.
  2. Choose Connect your application from the dialog box.
  3. Choose your driver as Nodejs and driver version as 3.6 or later.
  4. Copy the generated connection string. This is what youโ€™ll need further.
  5. Replace the by your own password.
  6. Don't forget to whitelist your IP address.

You can always refer to the docs for help: https://docs.atlas.mongodb.com/connect-to-cluster/

  1. Now, make a new file ".env" in the project folder and then define the database URI you generated earlier, like this:
DATABASE = "Your generated mongoDB URI"

6. Start the Express server and React development server.

After performing all of the setup steps in the Getting started section, navigate to the project root directory and run the following command to start the Express server and React development server.

yarn start

After the development server has started, a Chrome browser window should open, and you should see the login screen for the application. If the browser does not automatically open after the server starts, you can verify that the application is working locally on your computer by opening Chrome and going to http://localhost:8000.

Contributing guide

1. Fork the project repository: Fork this repository by clicking on the fork button on the top of this page. This will create a copy of this repository in your account.

2. Clone your fork: Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the copy to clipboard icon.

Open a terminal and run the following git command:

git clone "place here the url you just copied"

3. Create a new branch: Change to the repository directory on your computer (if you are not already there):

cd first-contributions Now create a branch using the git checkout command:

git checkout -b your-new-branch-name

Make changes in your local repository

4. Commit your Changes: If you go to the project directory and execute the command git status, you'll see there are changes.

Add those changes to the branch you just created using the git add command:

git add .

Now commit those changes using the git commit command:

git commit -m "a meaningful message"

5. Push your changes to Github: Push your changes using the command git push:

git push origin add-your-branch-name

replacing "add-your-branch-name" with the name of the branch you created earlier.

6. Submit changes for review: If you go to your repository on GitHub, you'll see a Compare & pull request button. Click on that button and submit the Pull request. Comment about your pull request.

Soon I'll be merging all your changes into the master branch of this project. (delete your branch from your fork after pull request gets accepted)


Issues:

If you find an issue while using the app or have a request, log the issue. These issues will be addressed in a future code update.

Contributors

Aman Jagdev Kartik Goel Gautam Arora

stockify's People

Contributors

amanjagdev avatar dependabot[bot] avatar gautam-arora24 avatar jainanuj261 avatar kg-kartik avatar shriyamadan avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

stockify's Issues

Implement Dark mode in the application

Implement dark mode through a toggle switch in a dark mode which switched between light and dark mode
Dark mode settings must persist even after refreshing the page.

Enhancement in UI:

I think in the navigation bar, the button Sign Up and Sign In would look better if there would be no gap b/w them. We can align them on the right side with a small gap. I think it would enhance UI.

image

Is this is valid issue @kg-kartik @amanjagdev @Gautam-Arora24 ??

I would like to work on it if it is valid.

React directory structure can be updated with segregated css files

In the client folder (React), each component or page can have it's own directory where lives a .jsx file and .css/.scss file. This will make the project structure more readable, and UI modification can be done easily.

For e.g. say Sign-up page.
Current dircectory structure:
client -> src -> pages -> SignUp.js

Proposed directory structure :
client -> src -> pages -> SignUp -> signup.component.js /.jsx
client -> src -> pages -> SignUp -> signup.styles.css / .scss

client -> src -> components -> -> .component.js/.jsx
client -> src -> components -> -> .styles.css/.scss

We can, therefore, have stylesheets for every single component instead of a single index.css

new

My name is Luis, I'm a big-data machine-learning developer, I'm a fan of your work, and I usually check your updates.

I was afraid that my savings would be eaten by inflation. I have created a powerful tool that based on past technical patterns (volatility, moving averages, statistics, trends, candlesticks, support and resistance, stock index indicators).
All the ones you know (RSI, MACD, STOCH, Bolinger Bands, SMA, DEMARK, Japanese candlesticks, ichimoku, fibonacci, williansR, balance of power, murrey math, etc) and more than 200 others.

The tool creates prediction models of correct trading points (buy signal and sell signal, every stock is good traded in time and direction).
For this I have used big data tools like pandas python, stock market libraries like: tablib, TAcharts ,pandas_ta... For data collection and calculation.
And powerful machine-learning libraries such as: Sklearn.RandomForest , Sklearn.GradientBoosting, XGBoost, Google TensorFlow and Google TensorFlow LSTM.

With the models trained with the selection of the best technical indicators, the tool is able to predict trading points (where to buy, where to sell) and send real-time alerts to Telegram or Mail. The points are calculated based on the learning of the correct trading points of the last 2 years (including the change to bear market after the rate hike).

I think it could be useful to you, to improve, I would like to share it with you, and if you are interested in improving and collaborating I am also willing, and if not file it in the box.

If tou want, Please read the readme , and in case of any problem you can contact me ,
If you are convinced try to install it with the documentation.
https://github.com/Leci37/stocks-Machine-learning-RealTime-telegram/tree/develop I appreciate the feedback

Add GitHub Repo Links to the site

A "Star us on GitHub" and "Fork us on Github" button need to be added in the web application without disturbing the styling and working of the application.
It would help newcomers to contribute to the project by directly staring and forking the repo.

Improve Documentation

The documentation doesn't provide much detail about the project and there is not enough information.
Documentation must cover topics :

  • Project Description
  • Technologies used
  • Getting Started: Local installation guide
  • Contributing guide

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.