OpenLake

JD-X: a web-development project for OpenLake
Report Bug / Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. Contact
6. Acknowledgments

About The Project

JD-X is an open-source website development project for OpenLake club of IIT Bhilai built using Express.js. It utilizes the HBS templating engine, CSS, JavaScript, and Bootstrap framework. The project aims to provide a flexible and efficient platform for developing dynamic web applications.

• OpenLake is a club of IIT Bhilai striving to create a future of open-source development.
• This project was created for ease of access for IIT Bhilai students & expand the reach of OpenLake by nurturing interest in students regarding the importance of open-source development which in turn enhances teamwork.

You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have contributed to this project!

Built With

• 
• 
• 
• 
• 

Getting Started

Prerequisites

1. git
2. nodejs

Installation

To install and set up the JD-X project, follow these steps:

1. Clone the repository:

   git clone https://github.com/sk-pathak/JD-X.git
   

2. Install the dependencies using npm:

   cd JD-X
   npm i
   

3. Start the server:

   npm start
   

4. Access the website: Open your browser and visit http://localhost:5000 to see the website in action.

Usage

To use JD-X, follow these guidelines:

1. Modify the existing templates or create new ones using HBS syntax. Update the CSS and JavaScript files to customize the front-end design.

2. Define the routes and handle requests in the routes directory. Add new routes or modify the existing ones to match your application's logic.

3. Utilize the provided middleware and modules for authentication, database connectivity, and other common functionalities. Extend or modify them as needed.

4. Leverage the Express.js and HBS documentation for detailed guidance on building web applications with the framework.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

1. Fork the repository.

2. Create a new branch:

   git checkout -b feature/your-feature-name
   

3. Make your changes and commit them:

   git commit -m 'commit message here'
   

4. Push your changes to the branch:

   git push origin feature/your-feature-name
   

5. Open a pull request on the original repository and provide a clear description of your changes. We will review & merge your changes as soon as possible!!

Contact

Sumit Pathak - -
Hemanth Kumar Reddy - -
Suraj Uttam Gaikwad - -
Nischay Rajput - -
Nishant Verma -

Acknowledgments

Some resources that were helpful in this project:-

• Bootstrap
• Codepen
• Img Shields
• GitHub Pages
• Simple Icons