phyleria / Open-Kommunity

Open-source website template tailored for school clubs and communities.

Open-Kommunity

Welcome to the Open-Kommunity Template! This project is designed to help school clubs create a professional and customizable online platform using the MERN stack (MongoDB, Express, React, Node.js).

Installation

Clone the repository:

   git clone https://github.com/your-username/Open-Kommunity.git
   cd Open-Kommunity

Install backend dependencies:

cd server
npm install

Install frontend dependencies:**

cd ../client
npm install

Configuration

Backend Configuration:

Create a .env file in the backend directory. Add the following environment variables:

PORT=3001
MONGO_URI=your_mongodb_uri
JWT_SECRET=your_jwt_secret

Frontend Configuration:

Create a .env file in the frontend directory. Add the following environment variable:

REACT_APP_API_URL=http://localhost:3001/api

Running the Application

Start the backend server:

cd backend
npm start

Start the frontend server:

cd ../frontend
npm run dev

Open your browser and navigate to http://localhost:3000 to see the application running.

Usage

Customize the website to fit your school club's needs by editing the React components and backend API routes. Add your own styling and features to make the website unique.

Contributing

Contributions are welcome!

License

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