Skip to content
This repository has been archived by the owner on Sep 24, 2024. It is now read-only.

neiist-dev/GCE-NEIIST-webapp

Repository files navigation

Build Status License: MIT

GCE-NEIIST webapp

GCE-Thesis

GCE-NEIIST is the home for our student's group, Grupo de Contacto com Empresas.

This platform aims to provide services for Técnico Lisboa students, such as:

  • Informative service about the group.
  • Events sign up (i.e. programming competitions, open-days)
  • GCE-Inside View: A project that shows different careers on Computer Science and Engineering.
  • GCE-Thesis: Using AI to classify MEIC masters' theses proposals. We provide a simple and intuitive interface to navigate through them.
  • Mr Thesis: a friendly chatbot, complementary to GCE-Thesis, that helps student to find a suitable thesis for themselves.

Note that this is a WIP project, and it is on alpha phase.


Setup and Run

  1. Fork the project (for more info see Fork, Clone, Remote)

  2. Set the backend environment variables, by duplicating .env.example (home directory of the project). Rename it to .env and set its values. This step includes the configuration of Mlab

  3. Set the frontend environment variables, by duplicating angular-src/.scripts/set-env.env.example. Rename it to set-env.env, and set its values.

Run the App

In order to run the project the required libraries need to be installed.

  1. Install node.

  2. On the home directory of the project, run npm run first-setup.

  3. If you wish, follow our recommendations.

  4. In case of errors, see our Troubleshooting page.

Running the server

  1. Go to the main directory and run npm run start or nodemon gce_base.
  2. To access the user interface, open a browser (Chrome is recommended) and go to localhost:8080.

Run Tests

To run the tests, run npm test.

Contributing

If you are wondering if you should contribute, this is a fine reading.

Please read our Contribution Guidelines. Please follow our Commit Message Style Guide while sending Pull Requests.

If you want to report bugs or requests features, open an issue, with the respective label.

A list of contributors (add yourself if you wish)

  • Rafael Belchior, GCE

  • Daniel Ramos,GCE

  • Inês Sequeira,GCE

  • Jorge Heleno, GCE


Branches

The repository has the following permanent branches:

master This contains the production code which has been released.

develop This contains the latest stable code. All the contributing Pull Requests must be sent to this branch. When we want to release the next version of the app, this branch is merged into the master branch.

License

This is a WIP, and it is covered by the MIT license.

You acknowledge and agree that we don't take any responsability of the outcome from the usage of this code. For more information, read LICENSE.md.

Contact

You can reach GCE's team @gce on our Discord channel

Alternatively, feel free to contact us using the feedback form at gce-neiist.org.

Code of Conduct

We follow Convenant Code Of Conduct.