Skip to content

Commit

Permalink
Update README.md and composer.json description
Browse files Browse the repository at this point in the history
  • Loading branch information
DavidePastore committed May 29, 2021
1 parent 18aeb12 commit 6f878e5
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 9 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# codice-fiscale-rest

[![Latest version][ico-version]][link-packagist]
[![Build Status][ico-travis]][link-travis]
[![Build Status][ico-github-actions]][link-github-actions]
[![Coverage Status][ico-scrutinizer]][link-scrutinizer]
[![Quality Score][ico-code-quality]][link-code-quality]
[![Total Downloads][ico-downloads]][link-downloads]
[![PSR2 Conformance][ico-styleci]][link-styleci]

A simple codice fiscale rest website based on [Silex](http://silex.sensiolabs.org/).
A simple codice fiscale rest website based on [Symfony](https://symfony.com/).


Installation
Expand All @@ -19,6 +19,12 @@ Installation
npm install
```

### Compile assets

``` bash
npm run dev
```


### Install dependencies from composer.json

Expand All @@ -30,14 +36,12 @@ composer install
Launch
------

To launch the application with the default port (`8080`), you can use the following command:
To launch the application, you can use the following command:

``` bash
composer start
symfony server:start
```

or alternatively you can edit the `start` script (under the `scripts` property) in the `composer.json` file, choosing the port that you prefer to use.


Test
----
Expand All @@ -55,14 +59,14 @@ If you have issues, just open one [here](https://github.com/DavidePastore/codice


[ico-version]: https://img.shields.io/packagist/v/DavidePastore/codice-fiscale-rest.svg?style=flat-square
[ico-travis]: https://travis-ci.org/DavidePastore/codice-fiscale-rest.svg?branch=master
[ico-github-actions]: https://github.com/DavidePastore/codice-fiscale-rest/workflows/Continuous%20Integration/badge.svg?branch=master
[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/DavidePastore/codice-fiscale-rest.svg?style=flat-square
[ico-code-quality]: https://img.shields.io/scrutinizer/g/davidepastore/codice-fiscale-rest.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/DavidePastore/codice-fiscale-rest.svg?style=flat-square
[ico-styleci]: https://styleci.io/repos/47505745/shield

[link-packagist]: https://packagist.org/packages/DavidePastore/codice-fiscale-rest
[link-travis]: https://travis-ci.org/DavidePastore/codice-fiscale-rest
[link-github-actions]: https://github.com/DavidePastore/codice-fiscale-rest/actions?query=workflow%3A%22Continuous+Integration%22
[link-scrutinizer]: https://scrutinizer-ci.com/g/DavidePastore/codice-fiscale-rest/code-structure
[link-code-quality]: https://scrutinizer-ci.com/g/DavidePastore/codice-fiscale-rest
[link-downloads]: https://packagist.org/packages/DavidePastore/codice-fiscale-rest
Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "davidepastore/codice-fiscale-rest",
"description": "A simple codice fiscale rest website based on Silex.",
"description": "A simple codice fiscale rest website based on Symfony.",
"keywords": ["codice","fiscale","rest","symfony", "tax", "code", "italian", "italy", "php"],
"authors": [
{
Expand Down

0 comments on commit 6f878e5

Please sign in to comment.