This repository is a part of the project by NMAMIT Tulu Studies department,Nitte titled "Documentation of Koraga Folk Knowledge and Dictionary Project".
The motive of building this repository is to create a website for the end users to search for the meanings of Tulu words collected by the Tulu Department of NMAMIT, Nitte
The tech stacks for building this website is listed below. More tech stacks are expected to be used which will be decided in course of development.
To start with the installtaion it is recommended to have Git and Node installed in the system. For the respective docs for their installation
step 1(optional): Check NodeJs version
node --version
## output: v20.12.2step 2: Clone the repository and move to the directory
git clone https://github.com/pratham-ak2004/tulucentre
cd tulucentrestep 3: Install dependencies. We recommend to use pnpm as your package manager for this repository
npm install
pnpm installstep 4: Run the dev server. Open the link dispalyed in the terminal window to open the server
npm run dev
pnpm run devWe have imposed some rules for contributions
- Follow the commit message format as mentioned in the next section
- Create pull request only to the
devbranch of this repository - Use
pnpmfor building the project - Use meaningful names for identifiers while working on the project
Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
The header is mandatory and the scope is optional
Your commit message should be one of the following types:
- feat: A new feature.
- fix: A bug fix.
- docs: Documentation only changes.
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc).
- refactor: A code change that neither fixes a bug nor adds a feature.
- perf: A code change that improves performance.
- test: Adding missing tests.
- chore: Changes to the build process or auxiliary tools and libraries such as documentation generation.
your commit message must conatain atleast type and subject.
Ex: feat: created navbar
For more information on commit message format, refer this documention by develar
