Add dependencies

This commit is contained in:
Robbie Antenesse 2019-09-04 12:05:03 -06:00
parent d8c00116e3
commit b0282ec705
4 changed files with 5847 additions and 1 deletions

3
.gitignore vendored Normal file
View File

@ -0,0 +1,3 @@
node_modules/
dist/
.cache/

View File

@ -8,6 +8,8 @@ An attempt at a viable alternative to Goodreads (currently lacking a name—idea
- [Project Scope](https://gitlab.com/Alamantus/book-tracker/wikis/Project-Scope)
- Features we feel are essential to the project. Anything beyond the scope should be discussed for later and not prioritized.
- [Dependencies Stack](https://gitlab.com/Alamantus/book-tracker/wikis/Dependencies-Stack)
- A list of dependencies used in the project and a short explanation of what each of them are for.
- [Contrubution Guidelines](./CONTRIBUTING.md)
- Subject to change but important to follow. Includes a basic code of conduct.
- [Project chat via Gitter](https://gitter.io/book-tracker)
@ -17,4 +19,32 @@ An attempt at a viable alternative to Goodreads (currently lacking a name—idea
- [Main Repo on GitLab](https://gitlab.com/Alamantus/book-tracker)
- Where all changes are made "official".
- [Mirror Repo on GitHub](https://github.com/Alamantus/book-tracker)
- Gets changes from GitLab pushed to it so people who prefer GitHub can contribute there as well. Pull requests and issues created here will also be addressed.
- Gets changes from GitLab pushed to it so people who prefer GitHub can contribute there as well. Pull requests and issues created here will also be addressed.
## Installation
To develop, you'll need to know how to use a terminal or shell on your computer.
Clone the repo to your computer with [Git](https://git-scm.com/) by running:
```
git clone https://gitlab.com/Alamantus/book-tracker.git
```
Then run use [Yarn](https://yarnpkg.com) to install the dependencies:
```
yarn
```
## Usage
After everything's installed, run the "start" NPM script to build and serve the front end:
```
npm run start
```
Then use your browser to navigate to http://localhost:1234 to view the website.
It's early days, so this segment will definitely change later as the project gets more complex.

29
package.json Normal file
View File

@ -0,0 +1,29 @@
{
"name": "book-tracker",
"version": "0.0.0",
"description": "An attempt at a viable alternative to Goodreads",
"main": "index.html",
"repository": "https://gitlab.com/Alamantus/book-tracker.git",
"author": "Robbie Antenesse <dev@alamantus.com>",
"license": "MIT",
"scripts": {
"start": "npm run watch-js",
"watch-js": "parcel watch src/index.html --no-hmr",
"serve-js": "parcel src/index.html",
"build": "parcel build src/index.html --no-source-maps",
"clear": "npm run clear-dist && npm run clear-cache",
"clear-dist": "rimraf dist/{*,.*}",
"clear-cache": "rimraf .cache/{*,.*}"
},
"devDependencies": {
"autoprefixer": "^9.6.1",
"parcel-bundler": "^1.12.3",
"parcel-plugin-goodie-bag": "^2.0.0",
"rimraf": "^3.0.0",
"sass": "^1.23.0-module.beta.1"
},
"dependencies": {
"choo": "^7.0.0",
"picnic": "^6.5.1"
}
}

5784
yarn.lock Normal file

File diff suppressed because it is too large Load Diff