Skip to content

Latest commit

 

History

History
78 lines (50 loc) · 3.85 KB

README.md

File metadata and controls

78 lines (50 loc) · 3.85 KB
Raw

Stoccoin-Website

[Under Development]

This is a web application for trading stocks and crypto, as well as displaying news feeds and real-time data processing for stock and crypto prices.

Tech Stack

The technology stack used for this project is:

  • Frontend: React.js, Tailwind CSS
  • Backend: Node.js, Express.js, MongoDB, Firebase

Getting started

To get started with this project, you'll need to follow these steps:

  1. Install Node.js and MongoDB on your local machine.
  2. Clone this repository to your local machine.
  3. Retrieve the API key from the official Firebase website and use it in auth.js.
  4. Install the project dependencies by running npm install in the app directory.
  5. Start the app by running npm run dev in the directory (cd app).
  6. Open your web browser and navigate to http://localhost:5173.

Contributing

We welcome contributions from anyone who is interested in improving this project. If you'd like to contribute, here are some ways you can get started:

Click here for the steps to Contribute

Issues

Here are some issues that need to be addressed in this project:

  • Improve the UI design for better user experience.
  • Add support for more cryptocurrencies and stock exchanges.
  • Implement user authentication and authorization for secure trading.
  • Optimize the application for performance and scalability.
  • Improve error handling and logging for better debugging.

If you're interested in working on any of these issues, please let us know by submitting a pull request or reaching out to us.

Contributors must finish their work for an issue within 4-5 days if they are either assigned or have shown interest in solving the issue to avoid conflicts.

Connect With Us

Twitter LinkedIn Instagram

Join our Discord Server:

We have a Discord server for contributors to the Stoccoin's website on GitHub. Join our community of developers, designers, marketers, and other contributors to share your skills, collaborate on code, provide feedback, and contribute to the Stoccoin's project in meaningful ways.

Click here to join our Discord server

License

This project is licensed under the Affero General Public License v3.0. See the LICENSE file for details.