Technojam Website Development Documentation

Table of Contents

• Technojam Website Development Documentation
  • Table of Contents
  • Introduction
  • Project Structure
  • Technologies Used
  • Installation
  • Running the Application
  • Getting Started
  • Learn More
  • Deploy on Vercel
  • Contributing
    • Fork the Repository
    • Clone the Fork
    • Create a Branch
    • Commit Changes
    • Husky (Pre-commit)
    • Push Changes
    • Create Pull Request
  • Coding Standards
  • Maintainers

Introduction

Welcome to the documentation for the development of Technojam's new website. This document provides a comprehensive guide to the project structure, technologies used, installation process, and guidelines for contributing.

Project Structure

The project follows a standard web application structure:

• /src: Contains the source code for the website.

• /src/components: Reusable React components.

• /pages: React components representing different pages.

• /styles: Stylesheets for the application.

• /utils: Utility functions.

• /data-components: data-visualizationa and funtions.

• /graphics-enhancements: graphics and 3d module components.

• /integrations: 3rd party integrations of web-apps and services.

• /newsletter: newsletter components.

• /content: all-pupose generic content holder.

• /blog: blog posts and reaction container holder.

• /vectors: vector library and files directory.

• /api: api directory.

• /lib: custom Exported ClassNames.

• /public: Static assets and HTML files.

• /docs: Documentation files.

Technologies Used

The website is built using the following technologies:

• React: A JavaScript library for building user interfaces.
• Node.js: A JavaScript runtime for server-side development.
• Next.js: A modular javascrip framework.
• Express: A web application framework for Node.js.
• MongoDB: A NoSQL database for storing dynamic data.
• Sass: A CSS extension language.
• Tailwind: A CSS enhancement Framework.

Installation

1. Clone the repository:

   git clone https://github.com/developers-sky/technojam-X.git
   cd technojam-x

2. Install dependencies:

   npm install

3. install husky:

   npm run prepare

Running the Application

Getting Started

First, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

This project uses next/font to automatically optimize and load Inter, a custom Google Font.

Learn More

To learn more about Next.js, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

Visit http://localhost:3000 in your browser to view the application.

Contributing

We welcome contributions from the community. Follow these steps to contribute:

Fork the Repository

Click on the "Fork" button on the top right of the repository page.

Clone the Fork

Clone your forked repository to your local machine:

git clone https://github.com/developers-sky/technojam-X.git
cd technojam-X

Create a Branch

Create a new branch for your feature or bug fix:

git checkout -b feature-name

Commit Changes

Make your changes and commit them:

git add .
git commit -m "Your commit message"

Husky (Pre-commit)

husky Pre-commit:

Husky is a pre-commit and hook tool, pre-check your code quality and vulnerability analysis. will automatically just work, when you commit files using

git push origin
    

or

git push 

Push Changes

Push your changes to your fork:

git push origin feature-name

Create Pull Request

Create a pull request on the GitHub repository. Provide a clear description of your changes.

Coding Standards

Follow the coding standards defined in the /docs/coding-standards.md file.

Maintainers

• Anurag Kumar Singh ([email protected])
• Neeraj Krishna ([email protected])
• Yash Singh ([email protected]) For any questions or concerns, feel free to contact the maintainers. Thank you for your contributions!