f.weber/homebrewery
0
0
Fork 0
mirror of https://github.com/naturalcrit/homebrewery.git synced 2026-01-06 23:02:45 +00:00
Code Wiki Activity

Merge pull request #2066 from craigelloyd/doc-fixes

Browse Source 
Fixed typos and some grammar things in README.md
This commit is contained in:
Trevor Buckner
2022-03-13 00:31:54 -05:00
committed by GitHub
parent 9282bdc09d 1a419f7e28
commit 2229686057
1 changed files with 28 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
README.md
View File

@@ -9,37 +9,37 @@ using [Markdown][markdown-url]. It is distributed under the terms of the [MIT Li
[markdown-url]: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet [markdown-url]: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
## Quick Start ## Quick Start
The easiest way to get started using the Homebrewery is to use it The easiest way to get started using The Homebrewery is to use it
[on our website][homebrewery-url]. The code is open source, so feel free to [on our website][homebrewery-url]. The code is open source, so feel free to
clone it, tinker with it. If you want to make changes to the code, you can run clone it and tinker with it. If you want to make changes to the code, you can run
your own local version for testing by following the installation instructions your own local version for testing by following the installation instructions
below. below.
[homebrewery-url]: https://homebrewery.naturalcrit.com [homebrewery-url]: https://homebrewery.naturalcrit.com
### Installation ### Installation
First, install three programs that the Homebrewery requires to run and retrieve First, install three programs that The Homebrewery requires to run and retrieve
updates: updates:
1. install [node](https://nodejs.org/en/) 1. install [node](https://nodejs.org/en/)
1. install [mongodb](https://www.mongodb.com/try/download/community) (Community version) 1. install [mongodb](https://www.mongodb.com/try/download/community) (Community version)
For easiest installation, follow these steps: For the easiest installation, follow these steps:
1. In the installer, uncheck the option to run as a service 1. In the installer, uncheck the option to run as a service.
1. You can install MongoDB Compass if you want a GUI to view your database documents 1. You can install MongoDB Compass if you want a GUI to view your database documents.
1. Go to the C drive and create a folder called "data" 1. Go to the C:\ drive and create a folder called "data".
1. Inside the "data" folder, create a new folder called "db" 1. Inside the "data" folder, create a new folder called "db".
1. Open a command prompt or other terminal and navigate to your mongodb install folder (c:program files\mongo\server\4.4\bin) 1. Open a command prompt or other terminal and navigate to your MongoDB install folder (C:\Program Files\Mongo\Server\4.4\bin).
1. In the command prompt, run "mongod", which will start up your local database server 1. In the command prompt, run "mongod", which will start up your local database server.
1. While MongoD is running, open a second command prompt and navigate to the mongodb install folder 1. While MongoD is running, open a second command prompt and navigate to the MongoDB install folder.
1. In the second command prompt, run "mongo", which allows you to edit the database 1. In the second command prompt, run "mongo", which allows you to edit the database.
1. Type `use homebrewery` to create the homebrewery database. You should see `switched to db homebrewery` 1. Type `use homebrewery` to create The Homebrewery database. You should see `switched to db homebrewery`.
1. Type `db.brews.insert({"title":"test"})` to create a blank document. You should see `WriteResult({ "nInserted" : 1 })` 1. Type `db.brews.insert({"title":"test"})` to create a blank document. You should see `WriteResult({ "nInserted" : 1 })`.
1. Search in Windows for "Advanced system settings" and open it 1. Search in Windows for "Advanced system settings" and open it.
1. Click "Environment variables", find the "path" variable, and double-click to open it 1. Click "Environment variables", find the "path" variable, and double-click to open it.
1. Click "New" and paste in the path to the mongodb "bin" folder 1. Click "New" and paste in the path to the MongoDB "bin" folder.
1. Click "OK", "OK", "OK" to close all the windows 1. Click "OK" three times to close all the windows.
1. install [git](https://git-scm.com/downloads) (select the option that allows Git to run from the command prompt) 1. install [git](https://git-scm.com/downloads) (select the option that allows Git to run from the command prompt).
Checkout the repo ([documentation][github-clone-repo-docs-url]): Checkout the repo ([documentation][github-clone-repo-docs-url]):
``` ```
@@ -54,7 +54,7 @@ the project to run locally.
You can set this temporarily in your shell of choice: You can set this temporarily in your shell of choice:
* Windows Powershell: `$env:NODE_ENV="local"` * Windows Powershell: `$env:NODE_ENV="local"`
* Windows CMD: `set NODE_ENV=local` * Windows CMD: `set NODE_ENV=local`
* Linux / OSX: `export NODE_ENV=local` * Linux / macOS: `export NODE_ENV=local`
Third, you will need to install the Node dependencies, compile the app, and run Third, you will need to install the Node dependencies, compile the app, and run
it using the two commands: it using the two commands:
@@ -63,7 +63,7 @@ it using the two commands:
1. `npm start` 1. `npm start`
You should now be able to go to [http://localhost:8000](http://localhost:8000) You should now be able to go to [http://localhost:8000](http://localhost:8000)
in your browser and use the Homebrewery offline. in your browser and use The Homebrewery offline.
### Running the application via Docker ### Running the application via Docker
@@ -95,11 +95,11 @@ You can check out the [changelog](./changelog.md).
## License ## License
This project is licensed under the [MIT license](./license). Which means you This project is licensed under the [MIT license](./license), which means you
are free to use The Homebrewery in any way that you want, except for claiming are free to use The Homebrewery in any way that you want, except for claiming
that you made it yourself. that you made it yourself.
If you wish to sell or in some way gain profit for what's created on this site, If you wish to sell, or in some way gain profit for, what's created on this site,
it's your responsibility to ensure you have the proper licenses/rights for any it's your responsibility to ensure you have the proper licenses/rights for any
images or resources used. images or resources used.
@@ -108,13 +108,12 @@ images or resources used.
You are welcome to contribute to the development and maintenance of the You are welcome to contribute to the development and maintenance of the
project! There are several ways of doing that: project! There are several ways of doing that:
- At the moment, we have a huge backlog of [issues][repo-issues-url] and some - At the moment, we have a huge backlog of [issues][repo-issues-url] and some
of them are outdated, duplicates or doesn't contain any useful info. In order of them are outdated, duplicates, or don't contain any useful info. To help, you can [mark duplicates][github-mark-duplicate-url], try to
to help you can [mark duplicates][github-mark-duplicate-url], try to reproduce some complex or weird issues, try finding a workaround for a
reproduce some complex or weird issues, try with finding a workaround for a reported bug, or just mention our issue managers team to let them know about
reported bug or just mention issue managers team to let them know about outdated issues via `@naturalcrit/issue-managers`.
outdated issue via `@naturalcrit/issue-managers`.
- Our [subreddit][subreddit-url] is constantly growing and there are number of - Our [subreddit][subreddit-url] is constantly growing and there are number of
bug reports: any help with sorting them out is very welcome. bug reports. Any help with sorting them out is very welcome.
- And of course you can contribute by fixing a bug or implementing a new - And of course you can contribute by fixing a bug or implementing a new
feature by yourself, we are waiting for your feature by yourself, we are waiting for your
[pull requests][github-pr-docs-url]! [pull requests][github-pr-docs-url]!