-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4 from metacpan/oalders/README
Update README
- Loading branch information
Showing
1 changed file
with
13 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,18 @@ | ||
# NAME | ||
|
||
Perl5-CoreSmokeDB-Web - Frontend SPA in VueJS to | ||
[Perl5-CoreSmokeDB-API](https://github.com/abeltje/Perl5-CoreSmokeDB-API#name) | ||
[Perl5-CoreSmokeDB-API](https://github.com/metacpan/Perl5-CoreSmokeDB-API#name) | ||
|
||
# DESCRIPTION | ||
## DESCRIPTION | ||
|
||
This software is the frontend to the API backend written in Perl. | ||
|
||
# INSTALLING | ||
## INSTALLING | ||
|
||
Before you start you'll need to install a more modern nodejs/npm than Ubuntu | ||
provides on Jammy. I did the following to get node v18 (check [their | ||
github](https://deb.nodesource.com)): | ||
|
||
Before you start you'll need to install a more modern nodejs/npm than Ubuntu provides on Jammy. | ||
I did the following to get node v18 (check [their github](https://deb.nodesource.com)): | ||
```bash | ||
curl -s https://deb.nodesource.com/gpgkey/nodesource.gpg.key \ | ||
| gpg --dearmor | sudo tee /etc/apt/keyrings/nodesource.gpg >/dev/null | ||
|
@@ -21,22 +23,24 @@ sudo apt install nodejs | |
``` | ||
|
||
After installing the API service, basically: | ||
|
||
```bash | ||
git clone https://github.com/abeltje/Perl5-CoreSmokeDB-Web.git | ||
git clone https://github.com/metacpan/Perl5-CoreSmokeDB-Web.git | ||
cd Perl5-CoreSmokeDB-Web | ||
npm install | ||
npm run dev | ||
``` | ||
|
||
Now point your webbrowser at `http://localhost:5173` | ||
|
||
# COPYRIGHT | ||
## COPYRIGHT | ||
|
||
© MMXXII - Abe Timmerman <[email protected]> | ||
|
||
# LICENSE | ||
## LICENSE | ||
|
||
This is free software; you can redistribute it and/or modify it under the same terms as Perl: | ||
This is free software; you can redistribute it and/or modify it under the same | ||
terms as Perl: | ||
|
||
- [the "Artistic License"](https://dev.perl.org/licenses/artistic.html) | ||
- [GNU General Public License](https://dev.perl.org/licenses/gpl1.html) | ||
|