Giter VIP home page Giter VIP logo

sod's Introduction

StockODiary

Stockodiary is a platform where traders related to financial markets create, plan, organize and analyze their trades.

Table of Contents

About

Stockodiary is a platform where traders related to financial markets create, plan, organize and analyze their trades.

Features

Installation

### Ubuntu
  1. Install required packages

    sudo apt-get update
    sudo apt-get install python3-pip python3-dev libpq-dev postgresql postgresql-contrib
  2. Create a Database

    sudo -u postgres psql
    CREATE DATABASE sod;
    \q
  3. Create a .env file in the root directory of the project and add the following environment variables:

    SOD_ENV="dev"
    DB_USER="<YOUR_DB_USER>"
    DB_PASSWORD="<YOUR_DB_PASSWORD>"

Usage

Note: For window users, replace python3 with python.

  1. Navigate to repo

    cd SOD/
  2. Create a Python environment

    python3 -m venv .venv --prompt "SOD"
  3. Activate the environment

    • Windows
    .venv\Scripts\activate
    • Linux/Mac
    source .venv/bin/activate
  4. Install the required packages

    python3 -m pip install -r requirements.txt 
  5. Make db migrations

    python3 manage.py migrate
  6. Run the server

    python3 manage.py runserver

Project will be running at localhost:8000

Contributing

We welcome contributions from the community! If you'd like to contribute to this project, please follow these guidelines:

  1. Fork the repository

  2. Clone it to your local machine.

    git clone https://github.com/sameershaik-coder/SOD.git
  3. Create a new branch for your feature or bug fix:

    git checkout -b feature-name
  4. Make your changes and commit them:

    git add .
    git commit -m '<Description of your changes>'
  5. Push your changes to your fork:

    git push origin feature-name
  6. Submit a pull request to the main repository's main branch.

If you find any bugs or have suggestions for improvements, please open an issue on the GitHub repository.

License

This project is licensed under the Apache 2.0 - see the LICENSE file for details.

However the code used for UI is not open source and must be purchased from the below url:

All rights related UI templates kit and source code related to templates kit belongs with owner listed in above urls.

Please contact and purchases licenses as applicable before you use the application in the production.

sod's People

Contributors

sameershaik-coder avatar trqlong26 avatar param302 avatar

Watchers

 avatar

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.