https://github.com/davidwarrington/transcend-con
https://github.com/davidwarrington/transcend-con
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/davidwarrington/transcend-con
- Owner: davidwarrington
- Created: 2018-03-30T17:44:54.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-05-13T14:11:12.000Z (about 7 years ago)
- Last Synced: 2025-04-01T15:54:04.089Z (2 months ago)
- Language: CSS
- Size: 17.6 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# East Riding College Transcend Conference 2018
This project was created by David Warrington, for the East Riding College Transcend HE Conference 2018. It can be seen live here: [159.65.24.94](http://159.65.24.94/).
## Table of Contents
- [How to Run](#how-to-run)
- [Changing Port](#changing-server-port)
- [How to Develop](#how-to-develop)
- [Server Structure](#server-structure)
- [dotenv](#dotenv)
## How to Run
To run this project, use the following command: `node server`.
### Changing server port
If the server needs to run on a port other than the default (3000), this can be done in one of two ways:
1. Open `server/config.js` and change the port property in the config to the one that you wish to use. For example, you can run it on port 8000 by changing the line to: `port: process.env.PORT || 8000,`.
2. The recommended method, for changing the port to run in a production environment is to change the port via the terminal command. If you wanted to run the server on port 80, for example, you would run the following command: `PORT=80 node server`.
- If you wish to add a more permanent method of keeping this port, rather than relying on remembering which port to use, add a new script to the scripts object in `package.json`. The line should look something like this: `production: PORT=80 node server`. This will allow you to run the same command every time by running `npm run production`. A better solution might be to name the script `start`, this way it can be started with the `npm start` command.
## How to Develop
To edit this project, once the repository has been downloaded, run the following commands:
1. `npm install`: This will install all of the project dependencies.
2. `npm run dev`: This will run the server in a *nodemon* instance, meaning that whenever a server file changes, the server will restart.
To edit the assets used on the front-end, such as *SASS* or *JS* files, run the following command:
1. `gulp`: This will run the default gulp file. Watching `.scss` files in `src/sass`, `.js` files in `src/js` and image files in `src/images`.
## Server Structure
The server is separates views, data and the server itself.
- JSON files found in `data/` should not be edited directly, instead, edit them by using the forms on the `/admin` routes whilst the server is running.
- Views are built using *PugJS*.
## dotenv
This server uses the *dotenv* package for obscuring information such as the Twitter App keys. In order to add your own Twitter app to be used for authentication, create a new app at [apps.twitter.com](https://apps.twitter.com/). Once this is done, you will need the Consumer Key and Consumer Secrets, place these in your `.env` file.
It should looks something like this:
```js
CONSUMER_KEY = 'key here'
CONSUMER_SECRET = 'secret here'
```
The `.env` file also contains an array of valid Twitter handles to be accepted as admins. They should look something like this:
```js
ADMIN_USERS = [ 'admin-01', 'admin-02' ]
```
Finally, it requires a secret key to be used by *Express Session*, which should look like this:
```js
SESSION_SECRET = 'secret here'
```