Skip to content

Cyb3rGhoul/inVIcTus

Repository files navigation

inVIcTus

Welcome to inVIcTus! This is a one-stop destination for all your academic needs, including a FFCS Planner, classroom finder, faculty finder, project submission portal, and contact form.

Image of the website

Installation

To get started with the project, follow these steps:

  1. Clone the repository:

    git clone https://github.com/your-username/inVIcTus.git
    cd inVIcTus
  2. Install dependencies:

    Make sure you have Node.js installed. Then, run:

    npm install
  3. Run the project:

    To start the development server, run:

    npm run dev

    The application should now be running on http://localhost:3000.

Usage

Once the project is set up and running, you can access various features like:

  • FFCS Planner: Plan your courses for the semester.
  • Faculty Finder: Find contact details and information about your faculty members.
  • Project Submission: Add and manage your academic projects.
  • Contact Form: Get in touch with the project maintainer.

Features

  • Responsive and user-friendly UI
  • Dark and light mode support
  • Easy navigation between different sections
  • Integration with external resources

Contributing

We welcome contributions from the community! If you have suggestions for new features, bug fixes, or improvements, feel free to contribute. Here’s how you can help:

  1. Fork the repository to your GitHub account.

  2. Clone your fork locally:

    git clone https://github.com/your-username/inVIcTus.git
    cd inVIcTus
  3. Create a new branch for your feature or bug fix:

    git checkout -b feature-name
  4. Make your changes and commit them:

    git commit -m "Description of the feature or fix"
  5. Push your branch to your fork:

    git push origin feature-name
  6. Open a pull request in the main repository. Please include a detailed description of your changes and the problem or feature they address.

License

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

Acknowledgements

ConnectWithMe

We hope you find this project useful! If you do, please consider giving us a star ⭐️ on GitHub to show your support.


Happy coding! 🚀