Skip to content

Latest commit

 

History

History
136 lines (92 loc) · 3.65 KB

README.md

File metadata and controls

136 lines (92 loc) · 3.65 KB
Raw

Dominion Organization Website

Welcome to the Dominion Organization Website repository! This project is built using Next.js and Sanity CMS to promote charity events, share news, and provide information about the organization.

Table of Contents

Introduction

This project aims to create a user-friendly and interactive website for the charity organization. The website showcases our mission, upcoming events, latest news, and provides an easy way for visitors to get involved and donate.

Features

  • Dynamic content management with Sanity CMS
  • SEO-friendly and fast performance with Next.js
  • Responsive design for all devices
  • Events calendar and news section
  • Contact form for inquiries and support
  • Donation integration

Technologies Used

  • Next.js - A React framework for server-side rendering and static site generation
  • Sanity CMS - A headless CMS for managing content
  • React - A JavaScript library for building user interfaces
  • Tailwind CSS - A utility-first CSS framework for styling
  • Vercel - A cloud platform for deploying Next.js applications

Installation

To get started with this project, follow these steps:

  1. Clone the repository:

    git clone https://github.com/skaleway/dominion.git
cd charity-organization-website

  2. Install dependencies

     pnpm isntall

Configuration

  1. Set up Sanity CMS:

    • Create a Sanity project at Sanity.io.
    • Generate an API token for your project.
    • Copy the sanity.json configuration file from your Sanity project to the root of this repository.

  2. Configure environment variables:

    Create a .env file in the root of your project and add the following environment variables:

    DATABASE_URL=""
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=""
CLERK_SECRET_KEY=""
NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL=""
NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL=""
UPLOADTHING_SECRET=""
UPLOADTHING_APP_ID=""

Running the Project

  1. Run the development server:

    pnpm dev

Deployment

This project can be easily deployed to Vercel. Follow these steps:

  1. Deploy to Vercel:

    • Push your project to a Git repository.
    • Go to Vercel and import your Git repository.
    • Set the required environment variables in the Vercel dashboard.
    • Deploy your project.

Contributing

We welcome contributions to this project! To contribute, follow these steps:

  1. Fork the repository:

    Click the "Fork" button at the top right of this page to create a copy of this repository under your GitHub account.

  2. Clone the forked repository:

    git clone https://github.com/skaleway/dominion.git
cd dominion

  3. Create a new branch:

    git checkout -b your-feature-branch

  4. Make your changes and commit them:

    git commit -m "feat: Your changes here"

  5. Push to the branch:

    git push origin your-feature-branch

  6. Create a pull request:

    Open a pull request from your branch to the main branch of this repository and describe your changes.

License

This project is licensed under the Skaling License. See the LICENSE file for details.