- Notifications
You must be signed in to change notification settings - Fork71
The chaijs.com website source code. Contributions welcome.
chaijs/chaijs.github.io
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
The chaijs.com website source code. Contributions welcome.
You need to havegit
,node
withnpm
andruby
withbundler
, then -with this repository checked out - you can run the following:
$ make install$ make
The site should be being served up onhttp://127.0.0.1:4000/.
You'll need to havegit
,node
withnpm
andruby
withbundler
. Followthe install instructions here for your operating system:
Installation on Debian Linux
If you're running a debian based distro, run the following command:
$ sudo apt-get install -y git nodejs ruby
Thenodejs
package on ubuntu is quite old, youprobably want a newerversion.Consult the documentation for adding the official Node.jsPPA
Now you'll need to installbundler
for ruby:
$ sudo gem install bundler
Installation on MacOS
Firstly ensure you havegit
which comes with the XCode Command Line Tools.You can run the following command:
$ xcode-select --install
You should now havegit
, you can check by running
$ git --versiongit version 2.20.1
If you have homebrew, you can simply runbrew install node
. Otherwise you'llneed to vist thenode.js site and downloadthe Node.js installer. Node ships with npm by default, so you should find thatwhen you runnode -v
andnpm -v
on the command line, you get some outputlike this:
$ node -v11.1.0$ npm -v6.4.1
Ruby comes installed by default on MacOS. Howeverbundler
does not. Toinstall bundler, run the following:
$ sudo gem install bundler
Now you should have bundler, you can check by running:
$ bundler -vBundler version 2.0.1
To clone the website to your local machine, run the following:
$ git clone https://github.com/chaijs/chaijs.github.io
It will generate a folder namedchaijs.github.io
, from within that directory,you can runmake install
to download the dependencies:
$ make install
Read the logs carefully, you might notice a message saying:
Following files may not be writable, so sudo is needed: ...
If you see this message, you can opt to runsudo make install
- oralternatively run the steps manually:
$ sudo bundle install$ npm install
The server can be run using the baremake
command, like so:
$ make
This command is shorthand for the following two commands:
$ make generated_data$ make docs-server
make docs-server
will run thejekyll
web server, which hosts the website onhttp://127.0.0.1:4000/. You should be able to visit thisURL and see a local copy of the chaijs website running.