Skip to content

Latest commit

 

History

History
135 lines (83 loc) · 5.27 KB

README.md

File metadata and controls

135 lines (83 loc) · 5.27 KB

Welcome to NoteUniv V2 project 👋

Website  Donate  Contributions  Tested on browsers  License  Size 

✨ NoteUniv: Website

NoteUniv V2 Website is a complete rework of the existing website, allowing more specific functionalities for both admins and students.


See the website in action (demo):

Website: https://beta.noteuniv.fr/

User: demo@etu.unistra.fr -> PWD: demo

Admin: admin@unistra.fr -> PWD: admin

📥 Installation

Requirements

⚡️ Easy setup

You can easily install the project with only one command:

./setup.sh # On linux

OR

setup.bat # On windows

Running the project

To deploy the project, follow these steps:

  1. Clone the repository using git
git clone https://github.com/NoteUniv/NoteUniv-V2-Website.git
cd NoteUniv-V2-Website/
  1. Install dependencies
composer install
npm install
  1. Copy the .env.example into .env and add your database credentials.

  2. ⚠️ You will need 2 template files for the application to work!

The MECC template to fill with specific subjects

The Grade template with a list of fillable options & students

Place them inside storage/app/private

  1. Execute the following commands:
php artisan key:generate
php artisan storage:link
php artisan migrate

php artisan db:seed

# Optionally set yourself as admin
# create an account first #
php artisan set-admin <your_student_id>
  1. Build the assets
npm run dev # or yarn dev
# OR
npm run watch # or yarn watch
  1. Finally start a php server or host it on a Apache/Nginx server
php artisan serve
  1. Open http://127.0.0.1:8000 on your browser!

👤 Auth

By default, 11 users are created (10 students + 1 admin)

Using php artisan db:seed, it will output a specific email and password to login

For the admin account, here are the credentials:

User: admin@unistra.fr -> PWD: admin

🤝 Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change or create a new branch.
Please make sure to test your suggestions before committing.

👥 Authors

Quentin L. & Solène G. & Eloi A.

Please ✰ this repository if this project helped you!

📖 License

CC BY-SA-4.0


Made withby NoteUniv team