Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Programmer-RD-AI committed Aug 8, 2024
1 parent c6c12d2 commit fc74a8e
Showing 1 changed file with 81 additions and 0 deletions.
81 changes: 81 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
# LuminaPress FrontEnd

## Overview

LuminaPress FrontEnd is the frontend application for LuminaPress, developed using ReactJS and hosted on Firebase Hosting. This repository encompasses the user interface, dynamic news visualizations, and responsive design to ensure a seamless experience across web platforms.

## Project Structure

- **src/**: Source code for the application
- **components/**: React components
- **pages/**: React page components
- **assets/**: Static assets like styles and images
- **redux/**: Redux state management
- **public/**: Publicly accessible files
- **cypress/**: End-to-end tests

## Getting Started

### Prerequisites

- Node.js (v14 or higher)
- npm or yarn

### Installation

1. Clone the repository:
```sh
git clone https://github.com/LuminaPress/LuminaPress-FrontEnd.git
```
2. Navigate to the project directory:
```sh
cd LuminaPress-FrontEnd
```
3. Install the dependencies:
```sh
npm install
# or
yarn install
```

### Running the Application

To start the development server, use:
```sh
npm start
# or
yarn start
```
This will launch the application in your default web browser.

### Running Tests

To run end-to-end tests with Cypress, use:
```sh
npx cypress open
# or
yarn cypress open
```

### Building for Production

To create a production build, use:
```sh
npm run build
# or
yarn build
```

This will generate static files in the `dist` directory that can be deployed to Firebase Hosting.

## Contributing

Feel free to open issues and submit pull requests. For major changes, please open an issue first to discuss what you would like to change.

## License

This project is licensed under the [Apache-2.0 License](LICENSE).

## Contact

For any questions or feedback, please reach out to [your email or contact information].

0 comments on commit fc74a8e

Please sign in to comment.