https://github.com/nevoland/foundation

🏛 Base repository for building JavaScript apps or libraries.
https://github.com/nevoland/foundation

boilerplate bundler front-end javascript library webapp

Last synced: about 2 months ago
JSON representation

🏛 Base repository for building JavaScript apps or libraries.

• Host: GitHub
• URL: https://github.com/nevoland/foundation
• Owner: nevoland
• Created: 2018-01-01T21:19:57.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2024-12-11T15:55:17.000Z (2 months ago)
• Last Synced: 2024-12-11T16:43:51.380Z (2 months ago)
• Topics: boilerplate, bundler, front-end, javascript, library, webapp
• Language: JavaScript
• Homepage:
• Size: 344 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Foundation

🏛️ Base repository for building JavaScript apps or libraries.

> To use this template, clone this repository and rename all "Foundation" instances to the name of your library.

> Set this package to "public" before publishing it.

### Uses

- [Vite](https://vitejs.dev)

- [Vitest](https://vitest.dev)

- [TypeScript](https://www.typescriptlang.org)

- [Prettier](https://prettier.io)

- [Eslint](https://eslint.org)

- [Tailwind](https://tailwindcss.com)

- [Typedoc](https://typedoc.org)

- [NVM](https://github.com/nvm-sh/nvm)

### Setup

- `nvm install`

- `npm install`

### Library mode

Use the application to test your library:

- `npm run dev`

- `npm run dev:test` (or use dedicated Vitest plugin of your IDE)

Build and publish the library:

- `npm run build:lib`

- Set the `private` property to `false` in [package.json](./package.json)

- `npm run release:init`

Release subsequent versions using either:

- `npm run release:alpha`

- `npm run release:beta`

- `npm run release:patch`

- `npm run release:minor`

- `npm run release:major`

### Application mode

Develop on the application:

- `npm run dev`

- `npm run dev:test` (or use dedicated Vitest plugin of your IDE)

Build and run:

- `npm run build:app`

- `npm start`

### Features

- List the main features of the library

- Explain how it distinguishes from other libraries

## Usage

Everything is exported from the main entry-point through an ES6 module:

```js

import { add } from "foundation";

```

## Installation

Install with the [Node Package Manager](https://www.npmjs.com/package/foundation):

```bash

npm install foundation

```

## Documentation

Documentation is generated [here](doc/README.md).