pingcrm/readme.md
Rodrigo Pedra Brum cbd3d8a8fd
Use npm ci to avoid package-lock update
Running `npm ci` instead of `npm install` avoids `package-lock` file update and installation of patch versions different from upstream.

This can be useful to avoid git pollution and to have exactly the same version of npm dependencies when debugging or writing an example to reproduce an issue.

`npm ci` was added to NPM to be used in Continuous Integration setups (hence the `ci`) keeping exactly the same versions of packages listed in package-lock file.
2019-11-06 01:39:47 -03:00

75 lines
1,001 B
Markdown

# Ping CRM
A demo application to illustrate how Inertia.js works.
![](https://raw.githubusercontent.com/inertiajs/pingcrm/master/screenshot.png)
## Installation
Clone the repo locally:
```sh
git clone https://github.com/inertiajs/pingcrm.git pingcrm
cd pingcrm
```
Install PHP dependencies:
```sh
composer install
```
Install NPM dependencies:
```sh
npm ci
```
Build assets:
```sh
npm run dev
```
Setup configuration:
```sh
cp .env.example .env
```
Generate application key:
```sh
php artisan key:generate
```
Create an SQLite database. You can also use another database (MySQL, Postgres), simply update your configuration accordingly.
```sh
touch database/database.sqlite
```
Run database migrations:
```sh
php artisan migrate
```
Run database seeder:
```sh
php artisan db:seed
```
You're ready to go! Visit Ping CRM in your browser, and login with:
- **Username:** johndoe@example.com
- **Password:** secret
## Running tests
To run the Ping CRM tests, run:
```
phpunit
```