Merge pull request #7 from Nummenpojat/updated-submodules

Updated submodules

Author: samvaol

.gitmodules

@@ -1,18 +1,19 @@
-# Suppis
-Innovative way to market 📣 and communicate 💬
-
-## Technologies
-Suppis uses [Whatsapp-Web.js](https://wwebjs.dev/) library as its main component, which is used to send messages and [Firebase](https://firebase.google.com/) for authentication and API security.
-Also some other technologies that Suppis uses are [Express](https://expressjs.com/) for API, [Typescript](https://www.typescriptlang.org/) for better developer experience and [React](https://reactjs.org/) on the frontend for the admin panel
-<p align="left"> <a href="https://www.w3schools.com/css/" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/css3/css3-original-wordmark.svg" alt="css3" width="40" height="40"/> </a> <a href="https://expressjs.com" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/express/express-original-wordmark.svg" alt="express" width="40" height="40"/> </a> <a href="https://firebase.google.com/" target="_blank" rel="noreferrer"> <img src="https://www.vectorlogo.zone/logos/firebase/firebase-icon.svg" alt="firebase" width="40" height="40"/> </a> <a href="https://www.w3.org/html/" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/html5/html5-original-wordmark.svg" alt="html5" width="40" height="40"/> </a> <a href="https://www.nginx.com" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/nginx/nginx-original.svg" alt="nginx" width="40" height="40"/> </a> <a href="https://nodejs.org" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/nodejs/nodejs-original-wordmark.svg" alt="nodejs" width="40" height="40"/> </a> <a href="https://reactjs.org/" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/react/react-original-wordmark.svg" alt="react" width="40" height="40"/> </a> <a href="https://tailwindcss.com/" target="_blank" rel="noreferrer"> <img src="https://www.vectorlogo.zone/logos/tailwindcss/tailwindcss-icon.svg" alt="tailwind" width="40" height="40"/> </a> <a href="https://www.typescriptlang.org/" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/typescript/typescript-original.svg" alt="typescript" width="40" height="40"/> </a> </p>
-
-## How to install 💾
-1. Clone project to your computer with `git clone https://github.com/Nummenpojat/Suppis.git`
-2. Clone submodules to your compoter with `git submodule update --init --recursive`
-
-## How to run in Docker
-1. Configure env in `docker-compose.yml`
-   - It has defaults that you can use
-   - If you wish to chance Nginx config look in to `/nginx/nginx.conf` file
-2. Run `docker compose up`
-3. Now Suppis is running inside Docker
+# Suppis
+Innovative way to market 📣 and communicate 💬
+
+## Technologies
+Suppis uses [Whatsapp-Web.js](https://wwebjs.dev/) library as its main component, which is used to send messages and [Firebase](https://firebase.google.com/) for authentication and API security.
+Also some other technologies that Suppis uses are [Express](https://expressjs.com/) for API, [Typescript](https://www.typescriptlang.org/) for better developer experience and [React](https://reactjs.org/) on the frontend for the admin panel
+<p align="left"> <a href="https://www.w3schools.com/css/" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/css3/css3-original-wordmark.svg" alt="css3" width="40" height="40"/> </a> <a href="https://expressjs.com" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/express/express-original-wordmark.svg" alt="express" width="40" height="40"/> </a> <a href="https://firebase.google.com/" target="_blank" rel="noreferrer"> <img src="https://www.vectorlogo.zone/logos/firebase/firebase-icon.svg" alt="firebase" width="40" height="40"/> </a> <a href="https://www.w3.org/html/" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/html5/html5-original-wordmark.svg" alt="html5" width="40" height="40"/> </a> <a href="https://www.nginx.com" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/nginx/nginx-original.svg" alt="nginx" width="40" height="40"/> </a> <a href="https://nodejs.org" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/nodejs/nodejs-original-wordmark.svg" alt="nodejs" width="40" height="40"/> </a> <a href="https://reactjs.org/" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/react/react-original-wordmark.svg" alt="react" width="40" height="40"/> </a> <a href="https://tailwindcss.com/" target="_blank" rel="noreferrer"> <img src="https://www.vectorlogo.zone/logos/tailwindcss/tailwindcss-icon.svg" alt="tailwind" width="40" height="40"/> </a> <a href="https://www.typescriptlang.org/" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/typescript/typescript-original.svg" alt="typescript" width="40" height="40"/> </a> </p>
+
+## How to use Suppis
+1. Clone project to your computer with `git clone https://github.com/Nummenpojat/Suppis.git`
+2. Check documentation for [Core](./docs/core.md)
+3. Run either normally or with Docker
+
+### How to run in Docker
+1. Configure env in [docker-compose.yml](docker-compose.yml)
+   - It has defaults that you can use
+   - If you wish to chance Nginx config look in to [nginx.conf](./nginx/nginx.conf) file
+2. Run `docker compose up`
+3. Now Suppis is running inside Docker

.idea/.gitignore

@@ -0,0 +1,3 @@
+node_modules
+.idea
+build

.idea/modules.xml

@@ -0,0 +1 @@
+API_BASE_URL=https://<your core domain>/api #

.idea/suppis.iml

@@ -0,0 +1,25 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+/.firebase
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*