Skip to content

xauth-ecosystem/nextjs-xauth-site

Repository files navigation

XAuth Ecosystem Official Website

Deploy Next.js site to Pages

This repository contains the source code for the official XAuth Ecosystem website. The site serves as a central hub for identity management solutions, providing access to documentation, downloads, and community resources.

Technologies Used

  • TypeScript / React 19: Core framework (Next.js 16.1.1)
  • Tailwind CSS: Modern styling with Typography plugin for documentation
  • Markdown-it: Powerful Markdown parser for dynamic documentation rendering
  • FontAwesome: High-quality vector iconography for the UI

Getting Started

To deploy a local copy of the project for development or testing, follow these simple steps.

Prerequisites

Before you begin, ensure you have the following tools installed:

  • Node.js (v18.0 or higher)
  • npm / yarn / pnpm

Installation

  1. Clone the repository:
    git clone [https://github.com/xauth-ecosystem/nextjs-xauth-site.git](https://github.com/xauth-ecosystem/nextjs-xauth-site.git)
  2. Install dependencies:
    npm install

Usage

To start the development server with hot-reload:

npm run dev

Open http://localhost:3000 with your browser to see the result. You can start editing the page by modifying app/page.tsx.

Deployment

This project is optimized for deployment on the Vercel Platform or GitHub Pages.

To create an optimized production build:

npm run build

To start the production server:

npm run start

Contributing

Contributions are welcome and appreciated! Here's how you can contribute:

  1. Fork the project
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Please make sure to update tests as appropriate and adhere to the existing coding style.

License

This project is licensed under the CSSM Unlimited License v2.0 (CSSM-ULv2). See the LICENSE file for details.

About

Static website for the XAuth Ecosystem, deployed on GitHub Pages and dynamically rendering Markdown documentation from a dedicated repository.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors