Skip to content

ISTTeo/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-Thesis: Using AI to classify MEIC masters' theses proposals. We provide a simple and intuitive interface to navigate through them.

Note that this is a WIP project.


Setup and Run

  1. Fork, Clone, Remote

  2. Set environment variables.

Run the App

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

  1. Install node.
  2. Install MongoDB, community version.
  3. Set the environment variables by editing and replacing its values on prepare_env_windows.bat if you are working on Windows or prepare_env_linux.sh if you are working on Linux.
  4. Run prepare_env_windows.bat or prepare_env_linux.sh using your console. Now your environment variables should be set.
  5. Run npm run first-setup. This script installs dependencies and builds the front end.
  6. If you wish,follow our recommendations.
  7. In case of errors, see our Troubleshooting page.

Running the server

  1. Go to the main directory and run node gce_base 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.

About

🌎 GCE-NEIIST web app

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • HTML 85.3%
  • JavaScript 11.3%
  • CSS 1.8%
  • TypeScript 1.4%
  • Python 0.2%
  • Batchfile 0.0%