Skip to content

Latest commit

 

History

History
70 lines (45 loc) · 1.18 KB

README.md

File metadata and controls

70 lines (45 loc) · 1.18 KB
Raw

What is Festify

Festify is a free and open-source framework for building fest management websites for colleges and universities. It is a one-stop solution for all the fests related activities. It is built with the MERN stack and is highly scalable and customizable.

Tech Stack

  • Frontend

    • React (CRA)
    • Redux
    • Redux Toolkit
    • CSS

  • Backend

    • Node.js
    • Express
    • MongoDB
    • Mongoose

  • Package Manager

    • npm

Getting Started

Prerequisites

  • Node.js
  • npm
  • MongoDB

Installation

  1. Clone the repo
git clone https://github.com/we-festify/festify.git
  1. Install NPM packages
npm install

  1. Create .env files in the directories and add the fields mentioned in the .env.example files.

  2. Run the client and server simultaneously in different terminals

cd client-web
npm start
cd server
npm start

Contributing

Contributions are always welcome!

See CONTRIBUTING.md for ways to get started.

Please adhere to this project's CODE_OF_CONDUCT.md.

License

Distributed under the Apache License 2.0. See LICENSE for more information.