Skip to content

iTjuana/itj-library

Repository files navigation

iTJ Library

iTj Library is an open source project for library management of the onsite office library. With this web aplication we are helping to keep better track of all library activities. This is a project for iTJ employees to contribute and aims to create an open source community.

Getting Started

If you are not familiar with the different technologies used in this project, please refer to the respective docs. If you still are in the wind, please join our Slack Channel #open-source-project and ask for help.

Contribute

🎉 First of all, thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to the ITJ Library project, which are hosted in the iTjuana on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Overview

Listed below are the basic steps for onboarding a new member to the team participating in the iTJ Library project, from the perspective of a Software Engineer.

Access to resources:

Set up

  • Request environment variables from the technical leader
  • Configure local development environment
  • Architecture
    • Web app: Next.js App deployed in Vercel
    • DB: PlanetScale
    • Identity Management: Auth0 / NextAuth
  • Work tools
    • Visual Studio Code
    • GIT
    • Node.js
    • T3 Stack

Execute the following commands:

npm install

npm run dev