Readlebee/README.md

# book-tracker

[![Read our Contribution Guidelines](https://badges.frapsoft.com/os/v1/open-source.svg?v=102)](./CONTRIBUTING.md) [![Issues](https://img.shields.io/github/issues/Alamantus/book-tracker.svg)](https://gitlab.com/Alamantus/book-tracker/issues) [![Join the chat at https://gitter.im/book-tracker/general](https://badges.gitter.im/book-tracker/general.svg)](https://gitter.im/book-tracker/general)

An attempt at a viable alternative to Goodreads (currently lacking a name—ideas welcome!)

## Important Links

- [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)
  - Real-time discussion about the project.
- [Issue Tracker](https://gitlab.com/Alamantus/book-tracker/issues)
  - For adding and tracking feature requests, feedback, and bug reports.
- [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.

## 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.