~fabiocbalbuquerque/sahana-agasti/web-services

1.1.183 by charles wisniewski
touched readme for a repository test
1
SAHANA AGASTI 2.0 MAYON 
1 by Usman Akeju
- initial commit; migrating to new branch internally
2
Emergency Management Software
3
4
Updated: 2010-11-18
5
6
Sahana Agasti is a free, open-source emergency preparedness and management
7
software application written in PHP by members of the Sahana Software
8
Foundation's developer community.
9
10
The mission of the Sahana Agasti project is to facilitate resource management
11
and communication throughout all phases of emergency management by providing a
12
turnkey open-source application that is reliable, scalable, extensible, and
13
usable both by volunteers and by professionals, and which supports the primary
14
goal of the Sahana Software Foundation: alleviating human suffering and saving
15
lives.
16
17
For more information on the Sahana Agasti project, visit
18
http://agasti.sahanafoundation.org/ or see the included DEVELOPERS file for
19
information on becoming a contributing developer.
20
21
For information on the Sahana Software Foundation, visit
22
http://www.sahanafoundation.org/.
23
24
INCLUDED DOCUMENTS
25
------------------
26
27
Information for this software can be found in the following included documents:
28
29
CHANGELOG  - Detailed release notes and version history
30
DEVELOPERS - Information for software developers
31
INSTALL    - Installation instructions
32
LICENSE    - Licensing information
33
README     - This document
34
35
36
WHAT'S NEW
37
==========
38
39
This is the initial release of the 2.0 series, named Mayon. It is largely a
40
development release and is NOT INTENDED FOR GENERAL USE.
41
42
The following major features are included in this first release:
43
44
- Simple installation process
45
- Minimal front-end UI design
46
- Rough tool for basic user account creation & administration
47
- Initial modules for limited Staff, Facility, and Scenario input & management
48
- Search, filter, and sorting capabilities for Staff data
49
- Staff export tool
50
- Extensive, flexible schema to support design & development of future features
51
- Built using symfony, an extensible web PHP framework, to ease development
52
53
For a more complete and detailed list of changes and fixes, including version
54
history, please see the included CHANGELOG file.
55
56
57
SYSTEM REQUIREMENTS
58
===================
59
60
*** IMPORTANT NOTE: ***
61
62
This software has been tested with the following technology stack, though other
63
platforms, web servers, and database engines may be supported with some
64
additional work. All documentation for this version of the software, however,
65
will assume the following setup:
66
67
Software
68
--------
69
70
The following software is required to run Sahana Agasti Mayon:
71
72
* Ubuntu 9.10 LTS or later (most current 10.04 LTS strongly recommended)
73
* Apache HTTP Server 2.2.14 or later (most current 2.2 preferred)
74
* MySQL 5.1.41 or later (most current 5.1 preferred)
75
* PHP 5.2.12 or later (most current 5.3 strongly recommended)
76
77
Hardware
78
--------
79
80
The following hardware resources are recommended to run Sahana Agasti Mayon:
81
82
* Intel Pentium or AMD Athlon CPU
83
* minimum of 50 MB available disk space
84
* minimum 512 MB RAM
85
86
87
INSTALLATION
88
============
89
90
For installation instructions, please see the included INSTALL file.
91
92
93
KNOWN ISSUES AND WORKAROUNDS
94
============================
95
96
IMPORTANT GENERAL NOTE: this is the initial release for the Mayon (2.0) series
97
of Sahana Agasti. The development team is aware that there are various kinks,
98
quirks, and that existing functionality and usability is limited. The software
99
is therefore NOT INTENDED FOR GENERAL USE in its current state.
100
101
This list covers some of the known problems (and workarounds, where applicable)
102
with Agasti 2.0 Mayon, which will be resolved in future releases:
103
1.1.171 by Darlene E McCullough
adding page templates for event and client, stub pages for event UI
104
- Some pages are currently stubs for development.  Those pages are marked at the top with a warning
105
  and the comment tag:
106
    // PnaODfcm3Kiz4MV4vzbtr4
107
  This random string is grepable for a report of the remaining stubbed pages.  When a developer 
108
  fleshes out one of these pages the tag should be removed.
109
1 by Usman Akeju
- initial commit; migrating to new branch internally
110
- After submitting the form on the install.php page, it may take up to 5 minutes
111
  to load and redirect to the login screen.
112
113
- The "Client" menu navigation item points to home; this module will be
114
  implemented in a future release.
115
116
- Pre-loaded fixtures for staff are not searchable; this is because fixture data
117
  is not currently indexed for searching when populating the schema through the
118
  install process. Any new data entered into the system, however, will be
119
  searchable.
120
121
- Sorting a list of Staff by name is currently buggy and may not sort correctly.
122
123
- It is currently not possible to add more than one service to a Facility
124
  Group's list of available resources.
125
126
- Editing user accounts is unstable and may fail with an error page.
127
128
- Omitting a date of birth when creating or editing a staff entry will fail with
129
  an error.
130
131
- Form validation has not been turned on in most places, so it is possible to
132
  enter invalid data into the system.
133
134
- The formatting on some pages may seem "off." Page elements may wrap or
135
  disappear based on your browser window size or screen resolution. As a
136
  temporary workaround, you may need to maximize your browser window or increase
137
  your screen resolution.
138
139
If you think you've found a new issue or bug, please refer to the SUPPORT
140
section of this document for information on what to do next.
141
142
143
SUPPORT
144
=======
145
146
FAQ
147
---
148
149
1. What is Sahana?
150
151
The Sahana Software Foundation is a non-profit organization whose goal is to aid
152
relief efforts in emergency situations through the creation and implementation
153
of technology. Please visit http://www.sahanafoundation.org/ for more
154
information.
155
156
2. What is Sahana Agasti?
157
158
Sahana Agasti is a set of software tools, developed in PHP, for managing
159
resources in the event of a large-scale emergency. Please visit
160
http://wiki.sahanafoundation.org/doku.php/agasti:start
161
162
3. What does Sahana Agasti do?
163
164
The current development release is the foundation for the Mayon series and is
165
not intended for general use. Although current functionality is limited, Sahana
166
Agasti Mayon is being actively developed, and this release includes an
167
installer, basic entry and management tools for emergency staff, facilities,
168
scenarios, and user accounts, and an extensible schema on top of the symfony web
169
application framework.
170
171
4. What is the difference between Sahana Agasti and Sahana Eden?
172
173
Agasti and Eden are both currently active projects approved and supported by the
174
Sahana Software Foundation; however, they are separate initiatives with
175
different functionality and goals. Visit http://wiki.sahanafoundation.org/ for
176
more information.
177
178
5. What if I have more questions?
179
180
Please use the information below, under Additional Support, to contact the
181
active volunteer community of the Sahana Software Foundation.
182
183
Additional Support
184
------------------
185
186
For the most up-to-date information regarding Sahana Agasti, please visit
187
http://wiki.sahanafoundation.org/doku.php/agasti:start
188
189
Direct support for use or development of Agasti can be found via our active
190
volunteer community:
191
192
1. Email
193
194
   For user support, please subscribe to the Sahana User list here:
195
   https://lists.sourceforge.net/lists/listinfo/sahana-user 
196
197
   You can also join the Agasti mailing list by going to
198
   https://lists.sourceforge.net/lists/listinfo/sahana-agasti
199
200
2. IRC
201
202
   Sahana Agasti developers are available on FreeNode IRC channels
203
   #sahana and #sahana-agasti.
204
205
3. Launchpad
206
207
   Please visit our Answers page on Launchpad, here:
208
   https://answers.launchpad.net/sahana
209
210
211
LICENSING
212
=========
213
214
For licensing information, please see the included LICENSE file.
215
216
217
Thank you for using Sahana Agasti!
218
                                     The Sahana Software Foundation
219
                                     http://www.sahanafoundation.org/
220