diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6aea090..819a654 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,8 +7,8 @@ Please note we have a code of conduct, please follow it in all your interactions ## Discussion -- Join the [Gitter community](https://gitter.im/book-tracker/general) to chat about the project or give feedback -- Add [Issues](https://gitlab.com/Alamantus/book-tracker/issues) for feature requests or bug reports +- Join the [Gitter community](https://gitter.im/Readlebee/community) to chat about the project or give feedback +- Add [Issues](https://gitlab.com/Alamantus/Readlebee/issues) for feature requests or bug reports ## Pull Request Process diff --git a/LICENSE b/LICENSE index cb7ccda..411da46 100644 --- a/LICENSE +++ b/LICENSE @@ -631,7 +631,7 @@ to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. - book-tracker + Readlebee Copyright (C) 2019 Robbie Antenesse This program is free software: you can redistribute it and/or modify @@ -652,7 +652,7 @@ Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: - book-tracker Copyright (C) 2019 Robbie Antenesse + Readlebee Copyright (C) 2019 Robbie Antenesse This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. diff --git a/README.md b/README.md index c706cfa..020c5c4 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,24 @@ -# book-tracker +# Readlebee -[![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) +[![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/Readlebee.svg)](https://gitlab.com/Alamantus/Readlebee/issues) [![Join the chat at https://gitter.im/Readlebee/community](https://badges.gitter.im/Readlebee/general.svg)](https://gitter.im/Readlebee/community) 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) +- [Project Scope](https://gitlab.com/Alamantus/Readlebee/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) +- [Dependencies Stack](https://gitlab.com/Alamantus/Readlebee/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) +- [Project chat via Gitter](https://gitter.io/Readlebee) - Real-time discussion about the project. -- [Issue Tracker](https://gitlab.com/Alamantus/book-tracker/issues) +- [Issue Tracker](https://gitlab.com/Alamantus/Readlebee/issues) - For adding and tracking feature requests, feedback, and bug reports. -- [Main Repo on GitLab](https://gitlab.com/Alamantus/book-tracker) +- [Main Repo on GitLab](https://gitlab.com/Alamantus/Readlebee) - Where all changes are made "official". -- [Mirror Repo on GitHub](https://github.com/Alamantus/book-tracker) +- [Mirror Repo on GitHub](https://github.com/Alamantus/Readlebee) - 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. ## Development @@ -30,7 +30,7 @@ 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 +git clone https://gitlab.com/Alamantus/Readlebee.git ``` Then run use [Yarn](https://yarnpkg.com) to install the dependencies: @@ -115,10 +115,10 @@ the current user's home folder using Git like so: ``` cd ~ -git clone https://gitlab.com/Alamantus/book-tracker.git && cd book-tracker +git clone https://gitlab.com/Alamantus/Readlebee.git && cd Readlebee ``` -This will download the entire project source code into a `book-tracker` folder. +This will download the entire project source code into a `Readlebee` folder. #### Step 3: Configure the Project @@ -136,7 +136,7 @@ the `config.example.json` looks like with some explanations of each field: "port": 3000 # the port that the server will serve the app from. "dbhost": "localhost" # Where the postgres server is "dbport": 5432 # What port the postgres server uses - "dbname": "book-tracker" # The name of the database book-tracker will use to make tables and store data in + "dbname": "Readlebee" # The name of the database Readlebee will use to make tables and store data in "dbuser": "root" # The username with access to your postgres database "dbpass": "password" # The password for the username above ... # more to come diff --git a/app/config.example.json b/app/config.example.json index c7e9b3f..e2c1d58 100644 --- a/app/config.example.json +++ b/app/config.example.json @@ -1,3 +1,3 @@ { - "siteName": "book-tracker" + "siteName": "Readlebee" } \ No newline at end of file diff --git a/app/images/book-pile.svg b/app/images/book-pile.svg deleted file mode 100644 index 6133a9f..0000000 --- a/app/images/book-pile.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/app/images/logo.svg b/app/images/logo.svg new file mode 100644 index 0000000..c598dda --- /dev/null +++ b/app/images/logo.svg @@ -0,0 +1,171 @@ + + + + + + + + + + + + + + + + +image/svg+xml + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/app/images/social.svg b/app/images/social.svg new file mode 100644 index 0000000..ab32af7 --- /dev/null +++ b/app/images/social.svg @@ -0,0 +1,201 @@ + + + + + + + + + + + + + + + + +image/svg+xml + + + + + + + + + \ No newline at end of file diff --git a/app/index.html b/app/index.html index ed97a04..80be1c0 100644 --- a/app/index.html +++ b/app/index.html @@ -5,7 +5,7 @@ - book-tracker + Readlebee @@ -13,7 +13,7 @@ - + diff --git a/app/manifest.webmanifest b/app/manifest.webmanifest index 52aaf84..3cc0930 100644 --- a/app/manifest.webmanifest +++ b/app/manifest.webmanifest @@ -1,6 +1,6 @@ { - "name": "book-tracker", - "short_name": "book-tracker", + "name": "Readlebee", + "short_name": "Readlebee", "icons": [ { "src": "../dev/images/icon-128.png", diff --git a/app/views/manager.js b/app/views/manager.js index f72034a..14202a6 100644 --- a/app/views/manager.js +++ b/app/views/manager.js @@ -1,5 +1,7 @@ import html from 'choo/html'; +import headerImage from '../../dev/images/header.png'; + import { homeView } from './home'; import { loginView } from './login'; import { searchView } from './search'; @@ -30,7 +32,7 @@ export const viewManager = (state, emit) => {