Skip to content

CapituloJaverianoACM/Website

Repository files navigation

Website

This project was bootstrapped with Create React App. To see a guide with some information on how to perform common tasks.

This project is the Frontend of ACM chapter webpage, is develop with React.js, to see the Backend develop in Django, visit the WebSiteAPI repository

Table of contents

Contributors

Name GitHub Rol
Juan Manuel Sánchez Lozano juanmsl Frontend developer
Mateo Florido Sanchez mateoflorido Frontend & DevOps

Prerequisites

We recommend work on Linux or on a Unix system, because it's easier to install packages and frameworks; but, if you want to work on Windows you can do it.

Docker

You must have docker installed and running on your computer. More information: Docker

First build the docker container

$ docker build -t acmwebsite:dev

Then, spin up the container once the build is done

$ docker run \
    -it \
    --rm \
    -v ${PWD}:/app \
    -v /app/node_modules \
    -p 3001:3000 \
    -e CHOKIDAR_USEPOLLING=true \
    acmwebsite:dev

If you want to run in "detached" mode, remember to run as -itd instead.

Node (npm)

You must have node.js on your computer, you can download it from their Webpage, or just run the following command if you are in a Debian and Ubuntu based Linux distribution.

$ curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
$ sudo apt-get install -y nodejs

When you have installed node.js you can check your version

$ node --version
v8.9.4

$ npm --version
5.6.0

When you have installed node.js with npm, install gulp (and i recommend to install yarn too)

$ sudo npm install -g gulp
$ curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
$ echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
$ sudo apt-get update && sudo apt-get install yarn

After install the packages, check them in your system

$ gulp --version
CLI version 3.9.1

$ yarn --version
1.3.2

If you have any problem installing the packages, visit the Node webpage, or Yarn webpage.

Installation

Clone the repository

$ git clone https://github.com/CapituloJaverianoACM/Website.git
$ cd Website

Install the requirements

Install node packages described in the package.json

$ yarn --prod=false

Running the ReactApp

$ npm start

After starting your local server you can test the ReactApp on http://127.0.0.1:3000/

Gulp tasks

This tasks are described in the gulpfile.babel.js file, and can help you to work with the project

To run gulp just run the following command, it start the default gulp task.

$ gulp

Furthermore there are another tasks that you can execute with the command below

$ gulp <taskname>
Taskname Description
build:styles Build styles.css file from the .scss files
build:fonts Copy all fonts in dev folder to the static folder
generate:todolist Generate the todolist and the fixmelist of the project
clean Clean the project of all the generated files
build Execute all build: tasks
clean:build Clean the project and after that build it

Licence

This project is licensed under the GPL-3.0 License - see the LICENSE.md file for details

About

This project is the Frontend of ACM chapter webpage

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •