└── README.md
/README.md:
--------------------------------------------------------------------------------
1 | # Sample Project SRS Adapted from
2 | 
3 | Apps:Lab KE
4 |
5 |
6 | =============== SRS start ==============
7 |
8 | ## Table of contents
9 | - [Company Overview](#company-overview)
10 | - [Travel Management System](#travel-management-system)
11 | - [License](#license)
12 |
13 | ## Company Overview
14 |
15 | In here you give a brief about the company working on the Software.
16 |
17 | ## Travel Management System
18 | This is a travel management system to manage all your company expense on travels and accommodation.
19 |
20 | #### Problem statement
21 | In this section you write the client problem statement as per the client. It should be brief and straight to the point.
22 |
23 | #### Proposed solution
24 | In this section write a brief proposed solution according to your technical understanding and to the best of your knowledge. You can cite some links from you R&Ds
25 |
26 | ### Key Features
27 | This will be the core of the project SRS. It should explicit, understandable by the client but easy to interprate to code by developers. To achieve this write it in user story format; The title is the story and the bullets are the "checklist"
28 | ##### User Auth
29 | - Each user using the system has a login credential to access system functionalities.
30 | - User should be able to login in with email and a password
31 | - Password should be more than 8 characters
32 | - Etc
33 | ##### Roles and Permissions
34 | - The system has permissions and roles for users.
35 | - Users are assigned different role and permission to perform different action in the system - for example approvals and the roles also give access to different sections in the system
36 | - Etc
37 | ##### Department and HOD
38 | - Company department and there head of departments module.
39 | - Department should have one or more HOD
40 | - Department are unique by name
41 | - Etc
42 | ##### Hotels and Accommodation
43 | - Management of recommended hotels and accommodation by the company on commission based model
44 | - Etc
45 | ##### Mode of travel
46 | - Employee different mode of travel for example Air, road, rail, sea
47 | - Etc
48 | ##### Travel Group
49 | - Manages different company travel groups, example managers, casuals etc travel groups.
50 | - Travel group – this helps to manage and assign different travel groups to different job groups.
51 | - We can have international and local company travel groups.
52 | - An employee can be assigned to different travel groups.
53 | - Etc
54 | ##### Company setup
55 | - Company details and information example logo, company name, country
56 | - Etc
57 | ##### Job group
58 | - Module for managing different job group within the company
59 | - Etc
60 | ##### Location and maps
61 | - This module manages travel locations and destinations on the map.
62 | - Etc
63 | ##### Travel management
64 | - This module allows employees to apply for travels and admin will monitor and approve travels,
65 | - User can view their active travels and travel status,
66 | - Admin can disapprove travels.
67 | - Etc
68 | ##### Travel allowance and expense
69 | - Travel expense tracker attract the allowance awarded to employee traveling and their travel expense.
70 | - Etc
71 | ##### User/Employee profile
72 | - This module allow employee/user to view his profile and his her travel and activities
73 | - Etc
74 | ##### Currency
75 | - For managing different currencies for example when an employee is flying to the US, his / her travel currency will be dollar.
76 | - Etc
77 | ##### Reports
78 | - Generate travel reports from the system
79 | - Etc
80 | ##### Travel notes and feedback
81 | - Allow the employee to update notes and give feedback to hr during and/or after travel
82 | - Etc
83 | ##### Travel gallery
84 | - This module gives the company employee an option to share their travel pictures on the company travel gallery and company social media.
85 | - Etc
86 |
87 | ### System solution
88 | Due to the nature of your business we propose you have: - More details to go here
89 | #### Backend/Dashboard application and/or admin system management.
90 | Your backend/admin panel details goes here
91 | The admin/dashboard/backend application will be mostly used by the company management staffs.
92 | It will used to manage, monitor, update and control the whole system.
93 | Super admin will be able to add staff and assign them role and permission and set company profile.
94 | Respective staff will be able to perform their respective task(s) per role(s) /permission(s) as per their job description.
95 | Staff actions and pages to view will be filtered by roles and permissions set.
96 | #### Landing page for guest customers.
97 | Write website/landing page details here
98 | The landing web application will allow guest and customer view the service offered by the travel company.
99 | The landing page will act as the company website with all the services, company contact, company profile.
100 | #### Mobile Application
101 | Write mobile application features here
102 | List the features of the mobile apps and its functionalities here;
103 | The mobile app will the following features :
104 | ##### Sign in and Signup
105 | - Employee should be able to create accounts on the app and login
106 | - Etc
107 | ###### Hotels and Accomodation
108 | - View all hotels and accomodation places offered by your company.
109 | - Etc
110 | ##### Travel Modes
111 | - Users should be able view all modes of travel in the app
112 | - Etc
113 | ##### Travel Groups
114 | - A user can be in one or more travel group
115 | - Etc
116 | ##### Location and Maps
117 | - App should show maps for travel locations and destinations
118 | - Etc
119 | ##### Travels
120 | - Employee should be able to apply for travels, view approval status for their travels
121 | ##### Travel Allowance and Expense Tracker
122 | - Employee should be able to track their allowances and expenses of each travel on the app
123 | - Etc
124 | ##### Feedback
125 | - Allow users to submit feedback for a travel/tour
126 | - Etc
127 | ##### Travel Gallery
128 | - Allow users to add pictures to their past travels and other people can also view this pictures.
129 | - User can share their photos with company social media
130 | - Etc
131 | #### API
132 | Give detail about API here
133 | API is an application interface that exchanged information between two or more applications.
134 | APIs provide extra security while sharing information.
135 | Think of API as the channel we will use to exchange information between the backend application (dashboard), mobile application and any third party application. And all the information will be stored in one central database (company database).
136 | #### Database
137 | Database details goes here
138 | The system will use a single relational database and a backup database for all the applications database.
139 | The database will be backed up automatically to avoid data loss.
140 | #### Security
141 | Security details goes here
142 | We prioritize application security and we focus more on application security to make sure that the users who use the system transact on a secure and protected system. We use token based requests and oauth authentication.
143 | Validate every transaction and http request in each step in the system.....
144 | #### Payment Gateway
145 | Payment details in case there is a payment in the system
146 | The following payment methods will be used in the system.
147 | 1. Mpesa
148 | 2. Cash
149 | 3. Debit/Credit Cards
150 |
151 | ### Technology Requirements
152 | You tech stack goes here
153 | The system will be developed using the latest technology. We will use the following technology to develop the web application;
154 | - Laravel framework and PHP – For server-side
155 | - HTML5, CSS3, VueJs – For frontend (interface).
156 | - OAuth, 2FA, Bycrt, token – For authentication, encryption and security
157 |
158 | And for mobile app;
159 | - Kotlin – since we will be communicating with the native features of android framework and phone hardware, we will use Kotlin to develop the mobile application
160 | - XML – for mobile application frontend (interface)
161 |
162 | And for database;
163 | - MySQL
164 |
165 | ### Non-Technology Requirements
166 | List you non-technology requirements here
167 | The web app will require up to date modern browser installed (chrome is highly recommended) on tablet, laptop or computer.Devices preferred will be laptops, desktop computers or tablet for the staff. But the web application will be adaptive and responsive – which mean it will be able to work perfectly even on a phone.
168 | The application will require data or Wi-Fi connection to be accessible over the internet
169 | Mobile applications are to be Android 4.4 (android kitkat) version and above.The applications will require internet connectivity to run
170 | 99.9% uptime server. This is a gurarentee from our end as the service provider.
171 |
172 | ### NOTES
173 | In case of any requirement update we will update the document and inform you.
174 |
175 | ### Contacts
176 | You contact detail goes here
177 |
178 | =============== SRS End ==============
179 |
180 | # License
181 |
182 | [](#)
183 |
184 | [](#)
185 |
--------------------------------------------------------------------------------