Code Monkey home page Code Monkey logo

stock-analysis's Introduction

Stock Analysis

Introduction

This is the public code repository for StockAnalysis.com. We want to build the world's best free investing website.

About the project

The site is running on React/NextJS and is written in Javascript and Typescript. It's styled with Tailwind CSS.

Key goals

  • Be the fastest finance website on the internet.
  • Have the best user experience of all the investing sites.
  • Be super easy to use and understand. Things should "just work" and feel intuitive to use.
  • The data and info should always be up-to-date and accurate.

How to contribute

Anyone is welcome to contribute to this project.

If you help drive significant improvements to the site, then you will get a free Stock Analysis Pro account as long as you remain an active contributor. Send an email to [email protected] for more info about that.

How to start

You can easily download the code and run the site on your own computer by cloning the repository and running "npm install" and "npm run dev".

Here are the steps to do it:

  1. First, make sure you have Visual Studio Code, Git and Node.js installed (they're all free)
  2. Create a folder on your desktop called "StockAnalysis"
  3. Open Visual Studio Code. Click "File" and "Open Folder" -- then find the folder you created and click "Select Folder"
  4. Hit CMD+J or CTRL+J to open the terminal in VS Code
  5. Write this exact command and hit enter: git clone https://github.com/stockanalysisdev/stock-analysis.git . (make sure to include the period at the end)
  6. Write this command and hit enter: npm install
  7. Write this command and hit enter: npm run dev
  8. You should now be able to open the site in your web browser with this URL: http://localhost:3001

Congrats! You now have the site running locally on your own computer, with the site's code ready to edit from Visual Studio Code.

License

This code is licensed under the MIT license. See the LICENSE file for more info.

stock-analysis's People

Contributors

kristjanmar avatar azidn1nja avatar marchiva99 avatar

Watchers

James Cloos 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.