https://github.com/spleafy/prismane-website
https://github.com/spleafy/prismane-website
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/spleafy/prismane-website
- Owner: spleafy
- Created: 2023-06-27T20:52:34.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-29T21:32:53.000Z (9 months ago)
- Last Synced: 2024-08-29T23:45:23.068Z (9 months ago)
- Language: MDX
- Homepage: https://prismane-website.vercel.app
- Size: 54.2 MB
- Stars: 2
- Watchers: 1
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome - spleafy/prismane-website - (MDX)
README
# Prismane Website
Welcome to the official **Prismane Website** repository. This repository contains the code for the official website of the [**Prismane**](https://github.com/prismaneui) UI library, built with **Next.js**. The website serves as a resource hub for developers, including documentation, changelog, and more.
## Table of Contents
- [Introduction](#introduction)
- [Prismane Repository](#prismane-repository)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Startup Script](#startup-script)
- [Tools Used](#tools-used)
- [Contributing](#contributing)
- [License](#license)
## Introduction
Prismane is a powerful and flexible UI component library designed to simplify the process of building modern web applications. This website serves as the main resource for users to explore the library, its components, and how to get started with it.
## Prismane Repository
For more information about the **Prismane** UI library, visit the [Prismane GitHub Repository](https://github.com/prismaneui/prismane).
## Prerequisites
Before you get started, make sure you have the following installed:
- **Node.js** (v16 or higher)
- **npm** or **Yarn** for package management
## Installation
To get started with this project locally, follow these steps:
1. Clone this repository:
```bash
git clone https://github.com/spleafy/prismane-website
cd prismane-website
```
2. Install the dependencies:
Using **npm**:
```bash
npm install
```
Or **Yarn**:
```bash
yarn install
```
## Startup Script
To run the project locally, use one of the following commands:
Using **npm**:
```bash
npm run dev
```
Using **Yarn**:
```bash
yarn dev
```
This will start the development server on [http://localhost:3000](http://localhost:3000).
### Build for Production
To build the website for production:
```bash
npm run build
```
Or with **Yarn**:
```bash
yarn build
```
## Tools Used
This project uses a range of tools to ensure the best development experience:
- **Next.js** – A powerful React framework for building static and dynamic websites.
- **React** – A JavaScript library for building user interfaces.
- **TypeScript** – A superset of JavaScript that provides type safety and helps with large-scale application development.
- **MDX** – A Markdown format that allows you to use JSX components inside Markdown content.
- **ESLint** – A tool for identifying and fixing problems in JavaScript/TypeScript code.
- **Prettier** – An opinionated code formatter.
- **Tailwind CSS** – A utility-first CSS framework for rapid UI development.
- **Phosphor Icons** – A set of icons used throughout the website.
## Contributing
We welcome contributions from the community! If you'd like to contribute to the Prismane website, follow these steps:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature-branch`).
3. Make your changes.
4. Commit your changes (`git commit -am 'Add new feature'`).
5. Push your branch to the forked repository (`git push origin feature-branch`).
6. Open a pull request on GitHub.
Please follow the [code of conduct](./CODE_OF_CONDUCT.md) and ensure your changes follow the code style used in this repository.
## License
This repository is open-source and available under the [MIT License](./LICENSE).
---
For any questions or concerns, feel free to open an issue or contact us.