Skip to content

Latest commit

 

History

History
74 lines (52 loc) · 1.61 KB

README.md

File metadata and controls

74 lines (52 loc) · 1.61 KB

Frontend

Overview

The frontend is built using React and Tailwind CSS. It provides a user interface for viewing stock information and allows editors to add new stocks.

Features

  • User authentication
  • Role-based content management
  • Responsive design
  • Editor-specific features for adding and managing stocks

Prerequisites

  • Node.js

Getting Started

  1. Clone the Repository

    git clone https://github.com/yourusername/stock-analysis-frontend.git
cd stock-analysis-frontend

  2. Install Dependencies

    npm install

  3. Run the Development Server

    npm start

Available Scripts

In the project directory, you can run:

  • npm run dev: Runs the app in development mode.
  • npm build: Builds the app for production.

Directory Structure

frontend/
├── src/
│   ├── components/
│   │   ├── Header.js
│   │   ├── Footer.js
│   │   └── StockForm.js
│   ├── context/
│   │   └── AuthContext.js
│   ├── pages/
│   │   └── StocksPage.js
│   ├── App.js
│   ├── index.js
│   └── ...
├── public/
├── package.json
└── tailwind.config.js

Tailwind CSS Setup

Tailwind CSS is used for styling. Ensure you have it properly set up in your project. Follow the official Tailwind CSS installation guide if needed.

Contributing

Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.