Getting started is easy, first make sure you have the system dependencies installed!
# System Dependencies
# 1) Checkout repository using git:
$ git clone firstname.lastname@example.org:epochtalk/epochtalk.git
# 2) SSL and Nginx setup
Install an SSL cert and edit the nginx .conf file (located /etc/nginx/default.conf) with server info and SSL cert info
$ cd epochtalk $ yarn
# 4) Copy the example.env file
This file specifies the server configurations and is necessary to run the server. You can edit the .env file later to specify the configurations as outlined in the Configuration section.
$ cd .. # cd back to project root $ cp example.env .env
# 5) Checkout and Run Migrations
Note: If you do not have brew installed, you must manually install Elixir
$ cd .. # (or just change directories outside of the epochtalk directory) $ brew install elixir # this installs elixir so we can run epoch migrations $ git clone email@example.com:epochtalk/epoch.git $ cd epoch $ mix deps.get # install project deps $ mix ecto.setup # create and migrate epochtalk database $ cd ../epochtalk # change directories back to epochtalk root
# 6) Initialize First User
First ensure that Postgres is installed and running. Before running Epochtalk for the first time, it is necessary to setup the database and first user account. The CLI tool will create the first board and admin account for the forum. From the root directory of the project run the following command:
$ node cli --create
# 7) Start the Epochtalk server
$ yarn run serve
# 8) Log in and change admin account information
Login to the admin account using the username
admin and password
admin1234. Visit your profile by clicking the link in the top right corner of the page, then change your username and password.