/x-api

this is a fun repo for me to try out different types of and probably all kinds api out there

Primary LanguageJavaScriptMIT LicenseMIT

Technologies involved

  • Frontend: React, tailwind
  • Backend: NodeJs,Express
  • Database: Sqlite
  • ORM: Prisma

How to contribute

This is simple guide for installation to pull request

Installation

First fork this repository and feel free to give it a star 🌟

Give your github username in the place of username

git clone https://github.com/<UserName>/Small-Projects.git

If you want to contribute to frontend

cd Small-Projects/Client

npm install
or
pnpm install
or
yarn install

If you want to contribute to backend

cd Small-Projects/Server

npm install
or
pnpm install
or
yarn install

Create a new branch

Branch creation rule

Start your branch with what type of issue and issue number

Example: feat-todo-issue#3 (here the feat is feature and the issue number is 3)

These are the common types, with these you can start branch name

commit types

Those who are working with the backend create a .env file in the root directory and add this to the file

DATABASE_URL="file:./dev.db"