Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/team-falkor/website
Source code for the falkor website
https://github.com/team-falkor/website
falkor react shadcn-ui tanstack-router vite website
Last synced: about 1 month ago
JSON representation
Source code for the falkor website
- Host: GitHub
- URL: https://github.com/team-falkor/website
- Owner: Team-Falkor
- License: mit
- Created: 2024-09-04T05:08:08.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-11-16T22:44:37.000Z (about 2 months ago)
- Last Synced: 2024-11-16T23:25:42.069Z (about 2 months ago)
- Topics: falkor, react, shadcn-ui, tanstack-router, vite, website
- Language: TypeScript
- Homepage: https://falkor.moe
- Size: 8.83 MB
- Stars: 9
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Falkor Website
This repository contains the source code for the Falkor website, built using **React** and **TypeScript**, with **Vite** for development and build processes.
## Features
- **Vite** for fast, efficient development.
- **TypeScript** for static typing and improved developer experience.
- **TailwindCSS** for styling.
- **ESLint** for code quality and consistency.
## Getting Started
### Prerequisites
- Node.js v16+
- npm, yarn, or bun (my personal pick)
### Installation
Clone the repository and install dependencies:
```bash
git clone https://github.com/Team-Falkor/website
cd website
npm install
```
### Running the Project
To start the development server:
```bash
npm run dev
```
To build for production:
```bash
npm run build
```
### Linting
Run ESLint to ensure code consistency:
```bash
npm run lint
```
## Project Structure
- `src/`: Main source code.
- `assets/`: Static files like images and fonts.
- `components/`: Reusable React components.
- `routes/`: Route components for each route.
- `styles/`: Tailwind configuration and global CSS files.
- `public/`: Public static assets.
- `vite.config.ts`: Vite configuration for build and development.
- `tsconfig.json`: TypeScript configuration.
- `tailwind.config.js`: TailwindCSS configuration.
## Contributing
We welcome contributions! Please create an issue or open a pull request.
## License
This project is licensed under the MIT License.