https://github.com/brunnerlivio/agile-ipsum

Generate an Agile Lorem Ipsum placeholder text
https://github.com/brunnerlivio/agile-ipsum

agile ipsum lorem

Last synced: 3 months ago
JSON representation

Generate an Agile Lorem Ipsum placeholder text

• Host: GitHub
• URL: https://github.com/brunnerlivio/agile-ipsum
• Owner: BrunnerLivio
• License: mit
• Created: 2019-10-24T11:31:57.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-03-23T17:32:03.000Z (almost 2 years ago)
• Last Synced: 2024-10-11T18:07:42.607Z (3 months ago)
• Topics: agile, ipsum, lorem
• Language: JavaScript
• Homepage: https://agile-ipsum.netlify.com/
• Size: 562 KB
• Stars: 11
• Watchers: 5
• Forks: 48
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


  





  Agile Ipsum





Generate agile Lorem Ipsum placeholder texts





  



## About

**Lorem Ipsum** is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.

In order to adjust the *Lorem Ipsum* to todays standart, the **Agile Ipsum** was born. Instead of

latin-looking words, the Agile Ipsum generates placeholder texts with **agile buzzwords**.

## What Does this Repository Contain?

This repository contains a website, built with a static site generator called [GatsbyJS](https://www.gatsbyjs.org/). The agile words are being stored in the [`dict.js`](content/dict.js) file, which are being read while building the website.

In addition to this, it also contains:

- [Code of Conduct](CODE_OF_CONDUCT.md) - our Code of Conduct

- [Contributing Guidelines](CONTRIBUTING.md) - a guide on how to contribute to the Agile Ipsum repository

- [License](LICENSE.md) - the standard MIT license under which the Agile Ipsum website is published

We recommend familiarizing yourself with the above sections, particularly if you are looking to make a contribution.

## Running the website locally

**Prerequisite**

- [Git](https://git-scm.com/)

- [Node.js >=10](https://nodejs.org/en/)

**Clone**

In order to preview the website locally, make sure you clone the repository on your machine using Git.

```bash

git clone https://github.com/BrunnerLivio/agile-ipsum.git

```

**Installing dependencies**

To install all the dependencies needed by this repository, change the directory using your shelll

into the newly cloned repository and run the install command by npm.

```bash

cd agile-ipsum

npm install

```

**Starting the website during development**

The development mode comes with live-reload functionality out of the box. In order to start the website, after you have installed the dependencies, simply run the following command.

```bash

npm start

```

**Building the website for producton**

The production bundle will get automatically minified and bundled. In order to build the project, simply run the following command. You will find the built assets in the `public/` folder.

```bash

npm run build

```