Update readme #2
Conversation
README.md
Outdated
|
|
||
| The first thing you do after forking the ACC-repo is to run "npm run build" and "npm run develop" to start the server, but as you will see, its not that easy. | ||
|
|
||
| To get started with Strapi you need to install PostgreSQL, and for that you need Homebrew. HomeBrew is a package manager that takes care of everything NPM or Yarn doesn´t. Read more about it on https://brew.sh/ |
There was a problem hiding this comment.
Unfortunately this is specific to mac, for this part can you make a separate section called "Setting up for mac" and I'll ask essam to create a "Setting up for windows" section
There was a problem hiding this comment.
Can you make a "Setting up for mac section", right now this implies it works for both operating systems
README.md
Outdated
| A quick description of your strapi application | ||
| Setting up Strapi | ||
|
|
||
| The first thing you do after forking the ACC-repo is to run "npm run build" and "npm run develop" to start the server, but as you will see, its not that easy. |
There was a problem hiding this comment.
also npm install. Can you make this more of a bullet point list or a step by step?
bjornrl
force-pushed
the
update-readme
branch
from
08ed1b4 to
e01ce01
Compare
There was a problem hiding this comment.
Can you use https://markdownlivepreview.com/ to write this in markdown? Look at the readmes of other repos https://github.com/strapi/strapi/ for example look at their use of headings, bullet lists, etc. That is standard for any repo.
Also can you add a section on github development workflow? (Forking, Pulling from upstream, pushing to origin, include that they need to add upstream because it's not there by default). There are multiple levels of headers, you'll want a big header for "Github Development Workflow" and smaller headers for its subsections. Same for the above
README.md
Outdated
|
|
||
| The first thing you do after forking the ACC-repo is to run "npm run build" and "npm run develop" to start the server, but as you will see, its not that easy. | ||
|
|
||
| To get started with Strapi you need to install PostgreSQL, and for that you need Homebrew. HomeBrew is a package manager that takes care of everything NPM or Yarn doesn´t. Read more about it on https://brew.sh/ |
There was a problem hiding this comment.
Can you make a "Setting up for mac section", right now this implies it works for both operating systems
README.md
Outdated
| A quick description of your strapi application | ||
| Setting up Strapi | ||
|
|
||
| The first thing you do after forking the ACC-repo is to run "npm run build" and "npm run develop" to start the server, but as you will see, its not that easy. |
There was a problem hiding this comment.
use syntax highlighting on code commands
README.md
Outdated
|
|
||
| This is the website that will get you started. Most of the steps here are taken directly from there. https://www.moncefbelyamani.com/how-to-install-postgresql-on-a-mac-with-homebrew-and-lunchy/ PS: This is only for mac. Not sure if it works the same way with Linux or Windows. | ||
|
|
||
| To install HomeBrew, run this command in your terminal: |
There was a problem hiding this comment.
Stuff like this shoudl have a header called "Installing homebrew"
README.md
Outdated
|
|
||
| To install HomeBrew, run this command in your terminal: | ||
| #### Proceedings for Mac users |
There was a problem hiding this comment.
This is to general. Instead of "Proceedings" say something like "Setting up database"
|
|
||
| /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" | ||
| 1. Install Homebrew by running command: `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`. _(This will ask for you password and confirmation of download)_ | ||
| 1. Check that homebrew is up to date and healty by running: `brew update` then `brew doctor` |
There was a problem hiding this comment.
Why are there a bunch of "1."s?
There was a problem hiding this comment.
On the markdown tutorial, it says to use 1.s to get a numbered list
| 1. Start Postgres service by running: `brew services start postgresql` | ||
| 1. If you get error: "Error: role 'postgres' does not exist", run command: `/usr/local/opt/postgres/bin/createuser -s postgres` | ||
|
|
||
| _Remember to run `npm run build` and `npm run develop` after doing these steps._ |
There was a problem hiding this comment.
This isn't related to setting up the database, it should be in a different section
| 1. Start Postgres service by running: `brew services start postgresql` | ||
| 1. If you get error: "Error: role 'postgres' does not exist", run command: `/usr/local/opt/postgres/bin/createuser -s postgres` | ||
|
|
||
| _Remember to run `npm run build` and `npm run develop` after doing these steps._ |
Walkthrough of how to set up Strapi with Homebrew and PostgreSQL