Skip to content

Latest commit

 

History

History
130 lines (97 loc) · 5.07 KB

README.md

File metadata and controls

130 lines (97 loc) · 5.07 KB
Raw

SaveTheInternet


Save the Internet with us

📌 About

On 20 June, the European Parliament voted on the Copyright Directive.
Members of the parliament are the only ones that can stand in the way of bad copyright legislation.

Note: This is a NodeJS revamp of the old website

💻 Website

Deployment:

https://savetheinternet.info

Staging (dev branch):

https://dev.savetheinternet.info/

🔧 Used technologies / Libraries / Frameworks

Frontend:

Name Version
JQuery 3.3.1
Tailwind CSS 0.6.1
flag-icon-css 4.7.0
cssnano 3.10.0
font-awesome 4.7.0
masonry-layout 4.2.1
simplelightbox 1.13.0
typed.js 2.0.8

Backend (NodeJS Dependencies):

Name Version
NodeJS 8.11.2
TypeScript 2.9.2
ExpressJS 4.16.3
EJS 2.6.1
server-favicon 2.5.0
i18n 0.8.3
cookie-parser 1.4.3
laravel-mix 2.1.11
tslint 5.10.0
ts-loader 3.5.0
body-parser 1.18.3
cross-env 5.2.0
dotenv 6.0.0
node-cache 4.2.0
express-github-webhook 1.0.6
fs-extra 6.0.1
moment 2.22.2
sharp 0.20.4
winston 3.0.0

📈 Local testing

This site is written in NodeJS and was built on top of the ExpressJS Framework.
Current deployment platform specifications:

  • NodeJS Version: v8.11.1
  • Operating System: Ubuntu 16.04.4 LTS
  • Architecture: x86_64

Installation & Quick setup:

  1. Open up your favorite terminal (and navigate somewhere you want to download the repository to)

  2. Make sure you have nodejs installed. Test by entering
    $ node -v
    If this returns a version number, NodeJS is installed. If not, get NodeJS here.

  3. Clone the repository and navigate to it.
    $ git clone https://github.com/savetheinternetinfo/website.git && cd website

  4. Run the post setup script to install typescript:
    $ npm run postsetup

  5. Install all dependencies by typing
    $ npm install

  6. Compile the assets
    $ npm run assets-dev

  7. Fill in your config secrets
    $ cp .env.dist .env

    And fill that file

  8. Start the server
    $ npm run dev

Or use Docker:

  1. Install Docker and docker-compose
  2. Clone the repository and navigate to it.
    $ git clone https://github.com/savetheinternetinfo/website.git && cd website

  3. Then run docker-compose run --rm npm i && npm run build this builds the container and the sources
  4. After that run docker-compose up this starts the docker container with the compiled sources

Developing & Building:

Build and run a local instance:
$ npm run dev

Build only:
$ npm run build

Start only:
$ npm start

Run TypeScript linter
$ npm run lint

Run file watcher for automatic builds:
$ npm run watch

Info:

Per default, the server runs on port 3000 (http://localhost:3000).
This can be customized in the config.ts file.