NKnights is a web application that enhances the learning experience of students and also helps teachers to manage things.
You can access the live demo of the application at https://nknights.vercel.app/.
The application is built with the following technologies:
- Next.js: A React framework for server-side rendering and static site generation.
- Tailwind CSS: A utility-first CSS framework for rapidly building custom user interfaces.
- Node.js: A JavaScript runtime built on Chrome's V8 JavaScript engine.
- MongoDB: A cross-platform document-oriented database program.
Before running the application locally, ensure you have the following dependencies installed on your machine:
- Node.js (version 12 or above)
- npm (version 6 or above)
To run the application locally, follow these steps:
-
Clone the repository to your local machine:
git clone https://github.com/your-username/nknights.git
-
Navigate to the project directory:
cd nknights -
Install the dependencies:
npm install
-
Setup Env
cp .env.example .env
-
Start the development server:
npm run dev
-
Open your browser and visit
http://localhost:3000to see the application running.
To build the production-ready version of the application, run:
npm run buildThis will generate an optimized build in the out directory.
To deploy the application to a hosting provider, you can use the next export command to generate a static version of the website:
npm run exportThe static files will be generated in the out directory, which you can then upload to your hosting provider.