Skip to content

Update readme #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
joshuachinemezu wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update readme #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,23 @@
# Brief info

This is the API package for [Bookworm React tutorial](https://github.com/Remchi/bookworm-react).

The free live-coding series is on [Youtube](https://github.com/Remchi/bookworm-react).
Copy link

@ibetween ibetween Oct 28, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @joshuachinemezu! This is the link to project code. Not youtube.


# Setup

Install `mongodb`. In root folder run `yarn`.
Download and install the latest version of [Nodejs](https://nodejs.org/en/download/).

Downaload and install [Yarn](https://yarnpkg.com/en/docs/install) on your machine.

Install [mongodb](https://www.mongodb.com/download-center)..

Clone this project by running the command on your teminal.

git clone https://github.com/Remchi/bookworm-api.git

In the root folder run the command in your terminal

yarn

Rename `env-sample` to `.env` and change it to your liking.
Rename `env-sample` to `.env` and change it to suit your configurations.