readme updated, services commented and redirects-file added

breeku · Dec 11, 2020 · ac6a924 · ac6a924
1 parent d1f5a2a
commit ac6a924
Show file tree

Hide file tree

Showing 6 changed files with 95 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -1,13 +1,18 @@
 # Tapahtumavaraus
 [![Coverage Status](https://coveralls.io/repos/github/breeku/OTP1-tapahtumavaraus/badge.svg?branch=master)](https://coveralls.io/github/breeku/OTP1-tapahtumavaraus?branch=master)
 
-## Devaus
+Tapahtumavaraus is an application with which event organizers are able to gather
+their events into one application and travellers may filter their events in
+order to reserve tickets.
+
+[![Coverage Status](https://coveralls.io/repos/github/breeku/OTP1-tapahtumavaraus/badge.svg?branch=master)](https://coveralls.io/github/breeku/OTP1-tapahtumavaraus?branch=master)
 
-### Projektin kloonaus
+## Devaus
+@ -7,7 +12,7 @@
 
 Vs-code:ssa tai muussa kehitysympäristössä etsi "clone repository" -toiminto, ja kopioi alla oleva linkki sen URL-kenttään:
 
-`git clone https://gitlab.com/breeku/tapahtumavaraus.git`
+`git clone https://github.com/breeku/OTP1-tapahtumavaraus`
 
 ### Riippuvuuksien asennus
 

diff --git a/frontend/public/_redirects b/frontend/public/_redirects
@@ -0,0 +1 @@
+/* /index.html 200
diff --git a/frontend/src/services/auth.js b/frontend/src/services/auth.js
@@ -3,6 +3,13 @@ import axios from 'axios'
 import jwt_decode from 'jwt-decode'
 import { BASEURL } from './config'
 
+/**
+ *
+ * @param {string} email
+ * @param {string} password
+ * @returns {string} token for login
+ */
+
 export const login = async (email, password) => {
     const account = {
         email,
@@ -17,6 +24,16 @@ export const login = async (email, password) => {
     }
 }
 
+/**
+ *
+ * @param {string} firstName
+ * @param {string} lastName
+ * @param {string} username
+ * @param {string} email
+ * @param {string} password
+ * @returns {string} token for login
+ */
+
 export const register = async (firstName, lastName, username, email, password) => {
     try {
         const account = {
@@ -36,16 +53,28 @@ export const register = async (firstName, lastName, username, email, password) =
     }
 }
 
+/**
+ * removes token for logging out
+ */
+
 export const logout = () => {
     localStorage.removeItem('token')
 }
 
+/**
+ * @returns {string} decoded user data
+ */
+
 export const getProfileData = () => {
     const token = localStorage.getItem('token')
     const decoded = jwt_decode(token)
     return decoded
 }
 
+/**
+ * @returns {string} current token
+ */
+
 export const getToken = () => {
     return localStorage.getItem('token')
 }
diff --git a/frontend/src/services/events.js b/frontend/src/services/events.js
@@ -2,18 +2,40 @@ import axios from 'axios'
 import { BASEURL } from './config'
 import { getToken } from './auth'
 
+/**
+ *
+ * @param {string} language
+ * @param {number} resultLimit
+ * @param {string} tags
+ * @returns {string} events by search
+ */
+
 export const getEvents = async (language, resultLimit, tags) => {
     const response = await axios.get(
         `${BASEURL}/api/events/${language}/${resultLimit}/${tags}`,
     )
     return response
 }
 
+/**
+ *
+ * @param {number} eventId
+ * @param {boolean} fetchEvent
+ * @returns {string} event
+ */
+
 export const getEvent = async (eventId, fetchEvent) => {
     const response = await axios.get(`${BASEURL}/api/events/${eventId}/${fetchEvent}`)
     return response
 }
 
+/**
+ *
+ * @param {number} eventId
+ * @param {number} reservationCount
+ * @returns {boolean} succesful
+ */
+
 export const postReservationCount = async (eventId, reservationCount) => {
     try {
         const token = getToken()
@@ -32,6 +54,13 @@ export const postReservationCount = async (eventId, reservationCount) => {
     }
 }
 
+/**
+ *
+ * @param {string} arvostelu
+ * @param {number} eventId
+ * @returns {boolean} succesful
+ */
+
 export const postReview = async (arvostelu, eventId) => {
     try {
         const token = getToken()
@@ -47,18 +76,21 @@ export const postReview = async (arvostelu, eventId) => {
     }
 }
 
+/**
+ *
+ * @param {string} arvostelu
+ * @param {number} eventId
+ * @returns {boolean} succesful
+ */
+
 export const updateReview = async (arvostelu, eventId) => {
     try {
         const token = getToken()
-        await axios.post(
-            `${BASEURL}/api/events/review/${eventId}/update`,
-            arvostelu,
-            {
-                headers: {
-                    authorization: token,
-                },
+        await axios.post(`${BASEURL}/api/events/review/${eventId}/update`, arvostelu, {
+            headers: {
+                authorization: token,
             },
-        )
+        })
         return true
     } catch (error) {
         console.log(error)

diff --git a/frontend/src/services/getTagNames.js b/frontend/src/services/getTagNames.js
@@ -1,6 +1,10 @@
 import axios from 'axios'
 import { BASEURL } from './config'
 
+/**
+ * @returns {string} tags' names
+ */
+
 export const getTagNames = async () => {
     const response = await axios.get(`${BASEURL}/api/tags/`)
     return response

diff --git a/frontend/src/services/profileEvents.js b/frontend/src/services/profileEvents.js
@@ -1,6 +1,12 @@
 import axios from 'axios'
 import { BASEURL } from './config'
 
+/**
+ *
+ * @param {string} token
+ * @returns {string} single event
+ */
+
 export const getEvent = async token => {
     try {
         const { data } = await axios.get(`${BASEURL}/api/user/`, {
@@ -15,6 +21,13 @@ export const getEvent = async token => {
     }
 }
 
+/**
+ *
+ * @param {string} token
+ * @param {number} eventID
+ * @returns {boolean} succesful
+ */
+
 export const removeReview = async (token, eventID) => {
     try {
         await axios.delete(`${BASEURL}/api/events/review/${eventID}/delete`, {