Make sure you have node and npm installed. You can install both here. Download the LTS version because it will be the most stable
npm install
This will install all the node modules needed for development.
If you try to skip to the next step, it probably won't work because there is an issue that happens with tailwind and the post processing of css. The issue can be found here
Luckily, so can the fix:
npm install tailwindcss@npm:@tailwindcss/postcss7-compat @tailwindcss/postcss7-compat postcss@^7 autoprefixer@^9
And just to be safe, also run the following:
npm audit fix
This should fix any vulnerabilities with dependencies in the application
Now you're ready to run the application! The application will be served on your localhost on port 8080 here
npm run serve
All major code files are in src
firebase.js
contains all the firebase code and coordinates withcomponents/Chat.vue
to send messages to the firestore realtime database. These two files contain the major code for the application.
There are 2 executables that are availble in the src folder. One is a bash file for Mac and Linux. The other is a batch file for Windows.
They pretty much run the commands in the Project Setup part of this README. THEY DO NOT INSTALL NODE FOR YOU. If you do not have node you will still have to install it yourself.
To run the executables do the following in a terminal in the src folder:
sh linux+mac_executable.sh
on Mac or Linux
OR open up command prompt in Windows and make sure you Run as Administrator, then type the command:
windows_executable.bat
in Windows