Polish README

This commit is contained in:
User
2026-08-14 14:26:31 +02:00
parent 52dc765da4
commit cb292f8cab
+102 -13
View File
@@ -1,20 +1,109 @@
<div align="center"> # Software X
<img width="1200" height="475" alt="GHBanner" src="https://ai.google.dev/static/site-assets/images/share-ais-513315318.png" />
</div>
# Run and deploy your AI Studio app A polished React + Vite landing page and community waitlist experience for a premium meme-coin launch platform. The app includes a hero section, ecosystem overview, funding narrative, tokenomics modal, roadmap, and a live waitlist flow backed by Firebase Firestore.
This contains everything you need to run your app locally. ## Overview
View your app in AI Studio: https://ai.studio/apps/55306b36-3d34-4fd9-a0e8-4c330db069c4 Software X is designed to present a high-trust launch narrative for a community-driven web3 product. The project combines brand storytelling, conversion-focused sections, and a waitlist system that tracks registrations and community momentum.
## Run Locally ## Highlights
**Prerequisites:** Node.js - Premium landing-page design with dark, modern visual language
- Conversion-focused sections for problem, solution, roadmap, and funding
- Tokenomics and vision modal experiences
- Waitlist registration and stats tracking powered by Firebase
- Responsive React interface built with Vite and TypeScript
## Tech Stack
- React 19
- Vite
- TypeScript
- Tailwind CSS
- Firebase Firestore
- Google GenAI SDK
## Project Structure
```bash
.
├── src/
│ ├── components/
│ ├── data/
│ ├── lib/
│ ├── App.tsx
│ ├── main.tsx
│ └── index.css
├── firebase-applet-config.json
├── firebase-blueprint.json
├── firestore.rules
├── .env.example
├── package.json
├── tsconfig.json
├── vite.config.ts
└── README.md
```
## Local Development
### Prerequisites
- Node.js 18+
- npm
### Install dependencies
```bash
npm install
```
### Environment variables
This project includes an example environment file at [.env.example](.env.example). Configure the variables required by your runtime environment before starting the app.
```bash
cp .env.example .env
```
The example file includes:
- `GEMINI_API_KEY`
- `APP_URL`
If you are running in AI Studio, configure these values through the platforms secrets/runtime settings as needed.
### Run the app
```bash
npm run dev
```
The app runs on port `3000` by default via the Vite config.
### Production build
```bash
npm run build
```
### Type checking
```bash
npm run lint
```
## Firebase + Waitlist
The waitlist logic is configured in [src/lib/firebase.ts](src/lib/firebase.ts). It uses Firebase Firestore to manage registrations, live statistics, and referral-based waitlist tracking.
Before using the live waitlist flow, make sure your Firebase config file is populated correctly in [firebase-applet-config.json](firebase-applet-config.json).
## Notes
- The app is structured as a marketing and launch-site interface, not a general-purpose backend app.
- If you are deploying this to a static host or custom frontend platform, ensure your environment variables and Firebase configuration are available in the deployment environment.
## Contributing
Pull requests and improvements are welcome. For any significant changes, open an issue or propose the update before making a large refactor.
1. Install dependencies:
`npm install`
2. Set the `GEMINI_API_KEY` in [.env.local](.env.local) to your Gemini API key
3. Run the app:
`npm run dev`