Constellation
Welcome to the Constellation documentation! This is your go-to resource for everything related to our project, from getting started guides to in-depth technical documentation. Whether you're a developer, designer, or just curious about what we're building, you'll find all the information you need here.
If you want to contribute, check out our Contributing Guide for guidelines on how to get involved. For technical details about our stack and architecture, head over to the Technical Stack section.
Getting Started
Prerequisites
- Node.js (version 18 or higher)
- Bun (for package management and running scripts)
- Git (for version control)
Installation
- Clone the repository:
git clone https://github.com/your-username/constellation.git cd constellation - Install dependencies:
bun install - Start the development server:
bun run dev - Open your browser and navigate to
http://localhost:3000to see the app in action!
Setting Up Your Environment
Checkout the .env.example file for the required environment variables and create a .env file in the root of the project with your own values. This includes API endpoints, OAuth credentials, and other configuration settings needed for development.
Bug Reporting and Feature Requests
If you encounter any issues or have ideas for new features, feel free to open an issue on our GitHub repository. Please provide as much detail as possible, including steps to reproduce the issue and any relevant screenshots or logs.
Contributing
We welcome contributions from the community! If you're interested in contributing, please read our Contributing Guide for information on how to get started, coding standards, and the contribution process.