Giter Club home page Giter Club logo

planet's Introduction

Maintainability Build Status

BeLL apps Angular reboot prototype Planet

Project to create a prototype for a reboot of the BeLL apps using Angular5 & CouchDB2.

To work on this

The only prerequisite is Vagrant. If you don't know about it, please do some research and try it. After cloning the repository, run vagrant up in the console. Once it's done installing the virtual machine it'll automatically start compiling the app. After about 10 seconds, you can open the app at localhost:3000.

Project guidelines

  • Please check out the project page for available tasks to work on.
  • Before contributing also be sure to read our style guide
  • Please clone the repository rather than forking, unless you're from outside the organization. It's easier for us to collaborate from a new branch on the same repository.
  • After cloning the repository please run npm run install-hooks to add the git hooks to your local repository.
  • If you see something that needs work, please create an issue. If the issue is on the frontend, please try to make it specific to one component.
  • To work on an issue, create a new branch with a descriptive title.
  • Please wait for at least two positive reviews before merging a PR into the master branch

Unit & end-to-end tests

There are two ways for running the tests. The first listed works from the host machine, and the second works after vagrant ssh and cd /vagrant:

npm run v-test (from host) or ng test (from vagrant) - Unit tests Open localhost:9876 once this is done compiling

npm run v-e2e (from host) or ng e2e (from vagrant) - End-to-end tests Results will appear in the console

Additional commands

Similarly, we have a few other npm commands that work from the host machine to run the ng commands from the Angular CLI

npm run v-serve = ng serve

npm run v-build = ng build

npm run v-lint = ng lint

npm run v-lint-fix = ng lint --fix This will fix any lint errors that TSLint can automatically fix

Also, the npm start command can include an additional LNG variable to serve from different language files. This must be run from within the vagrant (so after vagrant ssh and cd /vagrant) and runs in the format:

LNG=es npm start

This would serve the app from the Spanish language files.

Troubleshooting

I switched branches and now I'm missing a dependency...

The ideal solution would be to ssh into your vagrant and run npm install:

vagrant ssh
cd /vagrant
npm install

This doesn't always work. If you're having trouble or need to revert to the exact dependencies listed on the package.json, you need to remove all packages then install (after cd /vagrant above, run the commands):

rm -rf node_modules/*
npm install

The trailing /* will remove all files & sub-directories of node_modules. You won't be able to remove node_modules because of the link between the vagrant VM and your host.

Cannot GET /

There are two things you can try for this. First involves the node-sass module which can be problematic. You will need to rebuild it from the VM:

vagrant ssh
cd /vagrant
npm rebuild node-sass

The second is to rebuild the application. First you need to cancel the app in the screen with screen -x then CTRL-C. Then you can bring the app back up with one of the above commands or in another screen session with vagrant screen -dmS build bash -c 'cd /vagrant; ng serve'.

planet's People

Contributors

adepojubosun avatar ajgingrich avatar amanuely avatar arashdai avatar basnetsamriddhi avatar daisywatson avatar dogi avatar empeje avatar kigsmtua avatar lmmrssa avatar lucy811 avatar macnew avatar nirojdyola avatar olevim avatar paulbert avatar pr0chin avatar razu9861 avatar rupesh87 avatar sahilph avatar tille88 avatar yanglou1 avatar yaoxing1990 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.