Alamantus
/
Readlebee
mirror of https://gitlab.com/Alamantus/Readlebee.git
1
0
Fork 0
Code Issues Releases Wiki Activity
An attempt at a viable alternative to Goodreads (Mirror: Main repo on GitLab) https://gitlab.com/Alamantus/Readlebee
3 Commits 2 Branches 0 Tags 5 MiB
JavaScript 90.5%
HTML 5.6%
SCSS 3.9%
Go to file
Robbie Antenesse d98f93a8a4 Add starter files and structure with comments 2019-09-04 12:21:42 -06:00
src Add starter files and structure with comments 2019-09-04 12:21:42 -06:00
.gitignore Add dependencies 2019-09-04 12:05:03 -06:00
CONTRIBUTING.md Initial commit: Add README and basic CONTRIBUTING 2019-09-04 09:55:25 -06:00
README.md Add dependencies 2019-09-04 12:05:03 -06:00
package.json Add dependencies 2019-09-04 12:05:03 -06:00
yarn.lock Add dependencies 2019-09-04 12:05:03 -06:00

README.md

book-tracker

Read our Contribution Guidelines Issues Join the chat at https://gitter.im/book-tracker/general

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

Important Links

  • Project Scope
    • Features we feel are essential to the project. Anything beyond the scope should be discussed for later and not prioritized.
  • Dependencies Stack
    • A list of dependencies used in the project and a short explanation of what each of them are for.
  • Contrubution Guidelines
    • Subject to change but important to follow. Includes a basic code of conduct.
  • Project chat via Gitter
    • Real-time discussion about the project.
  • Issue Tracker
    • For adding and tracking feature requests, feedback, and bug reports.
  • Main Repo on GitLab
    • Where all changes are made "official".
  • Mirror Repo on GitHub
    • 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 by running:

git clone https://gitlab.com/Alamantus/book-tracker.git

Then run use Yarn 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.