faouziMohamed / mit-license

Host your own MIT license for your open source projects.

Home Page:https://mit.mfaouzi.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

MIT License web Template

MIT Logo

Host your own license for your open source projects.

Features

Theme toggle (light/dark) Usage of query parameters to prefill the license template.

There are only two parameters: holder and year.

  • The holder parameter is used to prefill the name field.
    • If the holder parameter is not set, the default value is the name defined in the .env file.
    • If however the value is not set in the .env file, the default value is <COPYRIGHT HOLDER>.
  • The year parameter is used to prefill the year field. If the year parameter is not set, the current year is used.
Some screenshots

Light theme Dark theme

Usage

The usage is simple. Just add the holder and year parameters to the URL. Example: https://<your-domain>/?holder=Faouzi Mohamed&year=2023

Development

You need to create a .env file in the root directory of the project and add the following variables:

NEXT_PUBLIC_SITE_URL=https://<your-domain>
NEXT_PUBLIC_COPYRIGHT_HOLDER=<COPYRIGHT HOLDER>

Then, install dependencies

yarn install
# or
# npm install

Finaly, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev

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

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.

License

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

About

Host your own MIT license for your open source projects.

https://mit.mfaouzi.com

License:MIT License


Languages

Language:TypeScript 85.4%Language:JavaScript 7.7%Language:CSS 5.5%Language:Shell 1.5%