Stock Profiles

About   |   Features   |   Technologies   |   Requirements   |   Starting   |   License   |   Author

🎯 About

Stock Profiles is a web application that allows users to view and analyze stock prices. It provides a user-friendly interface for navigating through various stock and their corresponding data.

✨ Features

🔓 Login with Google / GitHub
📊 Get a stock profile
📖 Get a stock list
💹 Get a stock chart
⁉️ Manage your queries
⭐ Add stock to your favorites
🌟 View your favorite stock
👤 View your profile

🚀 Technologies

The following tools were used in this project:

• Node.js
• React
• Next.js
• TypeScript
• Prisma
• PostgreSQL
• Tailwind CSS

✅ Requirements

Before starting 🏁, you need to have Git, Node, and pnpm installed.

🏁 Starting

1. Clone this project

   $ git clone https://github.com/Raxuis/stock-profiles

2. Access the project directory

   $ cd stock-profiles

3. Install dependencies

   $ pnpm install

4. Set up environment variables

   • Copy the .env.example file to create a new .env file:

     $ cp .env.example .env

   • Open the newly created .env file and fill in the required environment variables, particularly the PostgreSQL connection string:

     DATABASE_URL=postgresql://<username>:<password>@<host>:<port>/<database>
     

     Replace <username>, <password>, <host>, <port>, and <database> with your PostgreSQL credentials and database information.

5. Run the project

   $ pnpm dev

   The server will initialize at http://localhost:3000

📝 License

This project is under the MIT license. For more details, see the LICENSE file.

Made with ❤️ by Raphaël

 

Back to top

---