works with published version of wfpl, started on documentation

[contractor-progress.git] / INSTALL

diff --git a/INSTALL b/INSTALL
new file mode 100644 (file)
index 0000000..1fccecb
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,40 @@
+INSTALLING
+
+System Requirements:
+
+       * PHP 5
+       * MySQL
+       * apache
+
+You'll also need a recent version of wfpl in code/wfpl:
+
+       $ cd code
+       $ git clone git://github.com/JasonWoof/wfpl.git
+
+Apache settings:
+
+       There is .htaccess file with all the needed settings. You may need to
+       change apache's AllowOverride directive to allow these settings to be
+       changed in the .htaccessfile.
+
+       Also, since mod_rewrite does not allow you to redirect to relative URLs,
+       you'll have to edit the rewrite rules if you don't install this at the
+       root directory for the [sub]domain.
+
+Localization:
+
+       There are still several places that have the contractor's name hardcoded
+       to "Jason". This will be fixed at some point, but for now You'll have to
+       go through and fix it (unless you're name happens to be Jason.)
+
+Database:
+       
+       create a mysql database, and these tables: people.sql tasks.sql
+       code/wfpl/examples/session.sql
+
+       Create the Contractor account:
+               go to /logout in browser (this creates a session)
+               in mysql do: insert into wfpl_session_data (name,value,session_id) values("auth_username", "1", (select id from wfpl_sessions limit 1));
+               Then go to /people in your browser and create your account (first account created is administrator/contractor)
+       
+       Now you can create accounts for your customers, and/or create tasks for yourself.